PIpinterest
pins

Get Pin analytics

Changed on

Get analytics for a Pin owned by the "operation user_account" - or on a group board that has been shared with this account.

  • By default, the "operation user_account" is the token user_account.

Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:

  • For Pins on public or protected boards: Admin, Analyst.
  • For Pins on secret boards: Admin.

If Pin was created before 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then.

get/pins/{pin_id}/analytics

Request

  • Base URL
    https://api.pinterest.com/v5
  • Auth
    • OAuth 2
      Authorization codehttps://www.pinterest.com/oauth/
      Token URLhttps://api.pinterest.com/v5/oauth/token
      Scopesboards:read, pins:read
    • or OAuth 2
      Client credentials
      Token URLhttps://api.pinterest.com/v3/oauth/access_token/
      Scopesboards:read, pins:read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

pin_idstring required

Unique identifier of a Pin.

Query parameters

start_datestring date required

Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

end_datestring date required

Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

app_types'ALL' | 'MOBILE' | 'TABLET' | 'WEB'

Apps or devices to get data for, default is all.

Pin metric types to get data for. VIDEO_MRC_VIEW are Video views, VIDEO_V50_WATCH_TIME is Total play time. If Pin was created before 2023-03-20, Profile visits and Follows will only be available for Idea Pins. These metrics are available for all Pin formats since then. Keep in mind this cannot have ALL if split_field is set to any value other than NO_SPLIT.

split_field'NO_SPLIT' | 'APP_TYPE'

How to split the data into groups. Not including this param means data won't be split.

ad_account_idstring

Unique identifier of an ad account.

Response

The request has succeeded.

PinAnalyticsResponse required

Changes

  • v5b698c180678aRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • v589c27ed39cfdRevision changes
    • info

      the endpoint scheme security client_credentials was added to the API

    • info

      added the enum value PROFILE_VISIT to the property items/oneOf[subschema #1]/ of the query request parameter metric_types

    • info

      added the enum value USER_FOLLOW to the property items/oneOf[subschema #1]/ of the query request parameter metric_types