ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

pins

Get Pin analytics

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

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

Changed in 8 of the 29 revisions of this API.1438

Jun 4, 2026v5b698c180678a2See the full diff
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 14, 2024v589c27ed39cfd3See the full diff
- ○
  the endpoint scheme security client_credentials was added to the API
  api-security-added
- ○
  added the enum value PROFILE_VISIT to the property items/oneOf[subschema #1]/ of the query request parameter metric_types
  request-parameter-property-enum-value-added
- ○
  added the enum value USER_FOLLOW to the property items/oneOf[subschema #1]/ of the query request parameter metric_types
  request-parameter-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 14, 2023v552586a2747711See the full diff
- ○
  added the optional property additionalProperties/lifetime_metrics to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 14, 2023v5be19b77aa78a81See the full diff
- ▲
  removed the enum value IMPRESSION from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value OUTBOUND_CLICK from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value PIN_CLICK from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value QUARTILE_95_PERCENT_VIEW from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value SAVE from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value VIDEO_AVG_WATCH_TIME from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value VIDEO_MRC_VIEW from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ▲
  removed the enum value VIDEO_V50_WATCH_TIME from the property items/ of the query request parameter metric_types
  request-parameter-property-enum-value-removed
- ●
  for the query request parameter metric_types, the type/format of property items/ was changed from string/ to /
  request-parameter-property-type-changed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 14, 2022v5e041d7b0cef01See the full diff
- ●
  for the query request parameter ad_account_id, the maxLength was set to 18
  request-parameter-max-length-set
Jul 11, 2022v50d59987520111See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
Apr 8, 2022v5c561dee8c13761See the full diff
- ▲
  removed the enum value ATTRIBUTION_EVENT from the query request parameter split_field
  request-parameter-enum-value-removed
- ▲
  removed the enum value CONTENT_TYPE from the query request parameter split_field
  request-parameter-enum-value-removed
- ▲
  removed the enum value CONVERSION_TYPE from the query request parameter split_field
  request-parameter-enum-value-removed
- ▲
  removed the enum value OWNED_CONTENT from the query request parameter split_field
  request-parameter-enum-value-removed
- ▲
  removed the enum value PIN_FORMAT from the query request parameter split_field
  request-parameter-enum-value-removed
- ▲
  removed the enum value SOURCE from the query request parameter split_field
  request-parameter-enum-value-removed
- ●
  removed the optional property all from the response with the 200 status
  response-optional-property-removed
Dec 16, 2021v52a34d1d22a471See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history