Get user account top pins analytics
GET {{baseUrl}}/user_account/analytics/top_pins?start_date=2009-07-05&end_date=2009-07-05&sort_by=SAVE&from_claimed_content=BOTH&pin_format=ALL&app_types=ALL&metric_types=SAVE_RATE,ENGAGEMENT_RATE&num_of_pins=25&created_in_last_n_days=30&ad_account_id=88006977
Gets analytics data about a user's top pins (limited to the top 50).
- By default, the operation user_account
is the token user_account.
Optional: Business Access: Specify an adaccountid to use the owner of that adaccount as the "operation useraccount".
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | (Required) Metric report start date (UTC). Format: YYYY-MM-DD | |
end_date | string | (Required) Metric report end date (UTC). Format: YYYY-MM-DD | |
sort_by | string | (Required) Specify sorting order for metrics | |
from_claimed_content | string | Filter on Pins that match your claimed domain. | |
pin_format | string | Pin formats to get data for, default is all. | |
app_types | string | Apps or devices to get data for, default is all. | |
metric_types | string | Metric types to get data for, default is all. | |
num_of_pins | number | Number of pins to include, default is 10. Max is 50. | |
created_in_last_n_days | number | Get metrics for pins created in the last "n" days. | |
ad_account_id | number | Unique identifier of an ad account. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"date_availability":{"latest_available_timestamp":1649116799000,"is_realtime":false},"pins":[{"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":{"fugiat1b":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},"deserunt15":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"pin_id":"642396334344813594"},{"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":{"amet_fa":{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}},"pin_id":"642396334344813594"}],"sort_by":"IMPRESSION"}