Qodex.ai

Get Pin analytics

GET {{baseUrl}}/pins/:pin_id/analytics?start_date=1977-03-23&end_date=1977-03-23&app_types=ALL&metric_types=OUTBOUND_CLICK,IMPRESSION&split_field=NO_SPLIT&ad_account_id=55846658

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

KeyDatatypeRequiredDescription
start_datestring(Required) Metric report start date (UTC). Format: YYYY-MM-DD
end_datestring(Required) Metric report end date (UTC). Format: YYYY-MM-DD
app_typesstringApps or devices to get data for, default is all.
metric_typesstring(Required) Pin metric types to get data for, default is all.
split_fieldstringHow to split the data into groups. Not including this param means data won't be split.
ad_account_idnumberUnique identifier of an ad account.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"nulla_9":{"daily_metrics":[{"data_status":"READY","date":"2019-12-01","metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}},{"data_status":"READY","date":"2019-12-01","metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}}],"summary_metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}}}