Get Pin analytics
GET {{baseUrl}}/pins/:pin_id/analytics?start_date=<date>&end_date=<date>&app_types=ALL&metric_types=SAVE,USER_FOLLOW&split_field=NO_SPLIT&ad_account_id=4
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 adaccountid (obtained via List ad accounts) to use the owner of that adaccount as the "operation useraccount. In order to do this, the token user_account must have one of the following https://help.pinterest.com/en/business/article/share-and-manage-access-to-your-ad-accounts">Business Access roles on the ad_account:
- For Pins on public or protected boards: Admin, Analyst.
- For Pins on secret boards: Admin.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | (Required) Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today. | |
end_date | string | (Required) Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date. | |
app_types | string | Apps or devices to get data for, default is all. | |
metric_types | string | (Required) Pin metric types to get data for, default is all. | |
split_field | string | How to split the data into groups. Not including this param means data won't be split. | |
ad_account_id | number | Unique identifier of an ad account. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"Excepteur_1d_":{"lifetime_metrics":{"veniam_34":"\u003cinteger\u003e","ut_5f_":"\u003cinteger\u003e","reprehenderit4":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"BEFORE_CORE_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"adipisicing11c":"\u003cnumber\u003e","exercitation_ac":"\u003cnumber\u003e"}},{"data_status":"BEFORE_ASSIST_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"proident_ac9":"\u003cnumber\u003e","consectetur4d":"\u003cnumber\u003e"}}],"summary_metrics":{"cillum_65":"\u003cnumber\u003e","veniamfd":"\u003cnumber\u003e","nisi_2ab":"\u003cnumber\u003e","dolore_771":"\u003cnumber\u003e"}},"velit_6":{"lifetime_metrics":{"officia6":"\u003cinteger\u003e","adipisicingc4":"\u003cinteger\u003e","ut_4":"\u003cinteger\u003e","laborisd":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"PURCHASERS_METRIC_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"irure__dc":"\u003cnumber\u003e"}},{"data_status":"BEFORE_VIDEO_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"ullamco_6":"\u003cnumber\u003e","ex4":"\u003cnumber\u003e","quis72":"\u003cnumber\u003e"}}],"summary_metrics":{"nostrud_6a2":"\u003cnumber\u003e","consequat_64":"\u003cnumber\u003e","quis__22":"\u003cnumber\u003e"}},"sit42":{"lifetime_metrics":{"add":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"BEFORE_DATA_RETENTION_PERIOD","date":"\u003cstring\u003e","metrics":{"magnac5":"\u003cnumber\u003e","consectetur72":"\u003cnumber\u003e"}},{"data_status":"AUDIENCE_TOTAL_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"inea9":"\u003cnumber\u003e"}}],"summary_metrics":{"in_9":"\u003cnumber\u003e","culpa_f1":"\u003cnumber\u003e"}}}