Get Pin analytics
GET {{baseUrl}}/pins/:pin_id/analytics?start_date=<date>&end_date=<date>&app_types=ALL&metric_types=PIN_CLICK,USER_FOLLOW&split_field=NO_SPLIT&ad_account_id=47
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
{"in3_5":{"lifetime_metrics":{"veniam2":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"BEFORE_DEMOGRAPHIC_FILTERS_START_DATE","date":"\u003cstring\u003e","metrics":{"in_5bb":"\u003cnumber\u003e","enim_5c":"\u003cnumber\u003e"}},{"data_status":"AUDIENCE_TOTAL_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"ad0_7":"\u003cnumber\u003e"}}],"summary_metrics":{"sint_3":"\u003cnumber\u003e","laboris9db":"\u003cnumber\u003e"}},"occaecat_695":{"lifetime_metrics":{"reprehenderit886":"\u003cinteger\u003e","eiusmod_2":"\u003cinteger\u003e","labore80":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"BEFORE_DEMOGRAPHIC_FILTERS_START_DATE","date":"\u003cstring\u003e","metrics":{"voluptate915":"\u003cnumber\u003e","officia_1d":"\u003cnumber\u003e"}},{"data_status":"BEFORE_PIN_CREATED","date":"\u003cstring\u003e","metrics":{"ut_253":"\u003cnumber\u003e","magnaba2":"\u003cnumber\u003e"}}],"summary_metrics":{"enim_078":"\u003cnumber\u003e"}},"eiusmod_5c0":{"lifetime_metrics":{"irure2a":"\u003cinteger\u003e","non0ea":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"PROCESSING","date":"\u003cstring\u003e","metrics":{"labore50":"\u003cnumber\u003e","cillum5e":"\u003cnumber\u003e"}},{"data_status":"PROCESSING","date":"\u003cstring\u003e","metrics":{"consequat137":"\u003cnumber\u003e","in_b_":"\u003cnumber\u003e"}}],"summary_metrics":{"veniam4c":"\u003cnumber\u003e","doloree":"\u003cnumber\u003e","enim_78":"\u003cnumber\u003e"}},"cupidatat12":{"lifetime_metrics":{"eiusmod3c9":"\u003cinteger\u003e","non957":"\u003cinteger\u003e","dolor_b5":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"READY","date":"\u003cstring\u003e","metrics":{"cupidatata":"\u003cnumber\u003e"}},{"data_status":"AUDIENCE_TOTAL_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"laborisf":"\u003cnumber\u003e"}}],"summary_metrics":{"ametd":"\u003cnumber\u003e","non_d06":"\u003cnumber\u003e"}},"id_24e":{"lifetime_metrics":{"sunt637":"\u003cinteger\u003e","aliquipf":"\u003cinteger\u003e"},"daily_metrics":[{"data_status":"READY","date":"\u003cstring\u003e","metrics":{"ut_2":"\u003cnumber\u003e","ut0":"\u003cnumber\u003e"}},{"data_status":"BEFORE_AUDIENCE_MONTHLY_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"officiaf_1":"\u003cnumber\u003e","labore3":"\u003cnumber\u003e","commodo73":"\u003cnumber\u003e"}}],"summary_metrics":{"inca1":"\u003cnumber\u003e","veniam_d":"\u003cnumber\u003e","consecteture23":"\u003cnumber\u003e","eta":"\u003cnumber\u003e"}}}