Metrics

Pinterest metrics via API

Your customer connects their Pinterest account and your product queries 14 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "pinterest:impressions",
      "component": "number_v1",
      "metrics": [
        "impression"
      ],
      "dimensions": [
        "user"
      ]
    }
  ]
}
Example: "Impressions" in October, compared to September.

More Pinterest request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Impressions by format

The number of times your pins were seen by format.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "pinterest:impressions_by_pin_format",
      "component": "chart_v1",
      "metrics": [
        "impression"
      ],
      "dimensions": [
        "pin_format"
      ]
    }
  ]
}

Table

Featured pins

Performance of the Pins in your account during the analyzed period, regardless of when they were posted. This table only shows data for "your pins"; it does not include "other pins".

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "pinterest:pins",
      "component": "datatable_v1",
      "metrics": [
        "description",
        "impression",
        "save",
        "created_at"
      ],
      "dimensions": [
        "board_pin"
      ]
    }
  ]
}

Number

Engagement

The total number of engagements on your Pins, including clicks and saved Pins.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "pinterest:engagement",
      "component": "number_v1",
      "metrics": [
        "engagement"
      ],
      "dimensions": [
        "user"
      ]
    }
  ]
}

Numbers

9 metrics

  • Impressions

    The number of times your pins were viewed during the analysis period.

    pinterest:impressions
  • Engagement

    The total number of engagements on your Pins, including clicks and saved Pins.

    pinterest:engagement
  • Engagement Rate

    The total engagements with your Pins divided by the total number of times your Pins were seen. Engagements include Saved Pins, Pin clicks, and exit clicks

    pinterest:engagement_rate
  • Clicks

    The number of clicks on your pins during the analysis period.

    pinterest:clicks
  • Pins click rate

    The total number of clicks on your Pin to content inside or out of Pinterest, divided by the total number of times your Pins appeared on screen.

    pinterest:clicks_rate
  • Total pins saved

    Total number of times your pins were saved by other users (repins) during the analyzed period.

    pinterest:saved
  • Total pins

    Total number of pins posted to the account.

    pinterest:total_pins
  • Published Pins

    Number of Pins published during the analyzed period, considering only content visible to the public. Protected or restricted-visibility Pins are not included.

    pinterest:total_period_pins
  • Total boards

    Total number of boards created during the analyzed period.

    pinterest:total_boards

Charts

3 metrics

  • Impressions by format

    The number of times your pins were seen by format.

    pinterest:impressions_by_pin_format
  • Impressions by platform

    The number of times your pins were seen by platform.

    pinterest:impressions_by_platform
  • Engagement by format

    The total number of engagements on your Pins, by format, including clicks and saved Pins.

    pinterest:engagement_by_pin_format

Tables

2 metrics

  • Featured pins

    Performance of the Pins in your account during the analyzed period, regardless of when they were posted. This table only shows data for "your pins"; it does not include "other pins".

    pinterest:pins
  • Featured boards

    Boards that had the biggest impact on their audience.

    pinterest:boards

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.