Get pin analytics
get_pin_analyticsPinterest performance metrics for one published pin over a date range.
Use after a pin has been published for a while to report impressions,
saves and clicks. For the whole account use get_account_analytics; for
publish status use get_pin.
Returns pin_id, pinterest_pin_id, account_id, start_date, end_date,
provider_mode, totals (each metric summed over the range, lowercase
names), daily rows (empty with include_daily=false; pass that when the
totals are enough), source (stored or live) and data_as_of for stored
reads. total_comments and total_reactions are lifetime counts on live
reads and 0 on stored reads, which do not keep them: use source=live
for comments and reactions. They read 0 on every daily row, since
Pinterest does not report them per day. A pin deleted on Pinterest is answered from stored
history with removed_from_pinterest_at set, and fails with
pin_removed_on_pinterest when none is stored. Fails with not_found for
an unknown pin and with pin_not_published for a pin that has not
published yet; sandbox pins return zeroed metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pin_id | Yes | UUID of the pin, from list_pins or create_pin. | |
| source | No | Where to read from. auto (default): PinBridge's nightly stored history when it covers the range, else Pinterest. stored: history only (up to 366 days). live: always ask Pinterest (up to 90 days, counts against the read limit). | |
| metrics | No | Comma-separated Pinterest metric types, e.g. IMPRESSION,SAVE,PIN_CLICK,OUTBOUND_CLICK. Default: the organic engagement set. | |
| end_date | No | Inclusive end, YYYY-MM-DD. Default: today. Up to 366 days from stored history, 90 days when read live from Pinterest. | |
| start_date | No | Inclusive start, YYYY-MM-DD. Default: 30 days ago. | |
| include_daily | No | false: return only the range totals, with an empty daily list. Use it when the totals are all you need, e.g. over 90 days. Default: true. |