Get top performing pins
pinterest_get_top_pinsRank an account's pins by chosen metrics over a date window to reveal which content drives engagement, clicks, and saves.
Instructions
Rank the account's pins by a metric over a date window — the tool to reach for when asked what is working. Scope: user_accounts:read and pins:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort_by | No | Metric to rank by, e.g. IMPRESSION, SAVE, PIN_CLICK, OUTBOUND_CLICK, ENGAGEMENT. | |
| end_date | Yes | End of the window, inclusive. Date as YYYY-MM-DD. Must be within the last 90 days and no later than today. | |
| app_types | No | Restrict to a surface. Defaults to ALL. | |
| pin_format | No | ||
| start_date | Yes | Start of the window, inclusive. Date as YYYY-MM-DD. Must be within the last 90 days and no later than today. | |
| num_of_pins | No | How many pins to return, 1-50. Defaults to 10. | |
| content_type | No | ||
| metric_types | No | Metrics to return. Common values: ENGAGEMENT, IMPRESSION, PIN_CLICK, OUTBOUND_CLICK, SAVE, SAVE_RATE, TOTAL_AUDIENCE, ENGAGED_AUDIENCE, PROFILE_VISIT, USER_FOLLOW. Omit for all available. | |
| ad_account_id | No | Act on behalf of this ad account. Required only for business accounts operating on a shared asset. | |
| from_claimed_content | No | ||
| created_in_last_n_days | No | Only consider pins created in the last N days. |