Get user account top pins analytics
GET {{baseUrl}}/user_account/analytics/top_pins?start_date=<date>&end_date=<date>&sort_by=SAVE&from_claimed_content=BOTH&pin_format=ALL&app_types=ALL&content_type=ALL&source=ALL&metric_types=IMPRESSION,IMPRESSION&num_of_pins=10&created_in_last_n_days=30&ad_account_id=4
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. 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. | |
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. | |
content_type | string | Filter to paid or organic data. Default is all. | |
source | string | Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts | |
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":"\u003cnumber\u003e","is_realtime":"\u003cboolean\u003e"},"pins":[{"metrics":{"quis_bf6":"\u003cnumber\u003e","velite8":"\u003cnumber\u003e"},"data_status":{"sunt03c":"BEFORE_PUBLISHED_METRIC_START_DATE"},"pin_id":"\u003cstring\u003e"},{"metrics":{"exercitation1f":"\u003cnumber\u003e","magna_e":"\u003cnumber\u003e","consectetura":"\u003cnumber\u003e","reprehenderit_0cc":"\u003cnumber\u003e","cupidatat_25":"\u003cnumber\u003e"},"data_status":{"anim_80":"BEFORE_PUBLISHED_METRIC_START_DATE"},"pin_id":"\u003cstring\u003e"}],"sort_by":"ENGAGEMENT"}