v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB

campaigns

Get pins analytics

Get analytics for the pins given a campaign and pins in the specified ad_account_id, filtered by the specified options.

The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
If granularity is not HOUR, the furthest back you can are allowed to pull data is 90 days before the current date in UTC time and the max time range supported is 90 days.
If granularity is HOUR, the furthest back you can are allowed to pull data is 8 days before the current date in UTC time and the max time range supported is 3 days. Data will not be provided for conversion metrics but will be available for non-conversion metrics.

get/ad_accounts/{ad_account_id}/pins/analytics

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

campaign_idstring required

Campaign Id to use to filter the results.

pin_idsPinterestLibIntegerFormatType[] required

List of Pin IDs.

start_datestring date required

Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

end_datestring date required

Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

columnsReportingColumnSync[] required

Columns to retrieve, encoded as a comma-separated string. NOTE: Any metrics defined as MICRO_DOLLARS returns a value based on the advertiser profile's currency field. For USD, ($1/1,000,000, or $0.000001 - one one-ten-thousandth of a cent). it's microdollars. Otherwise, it's in microunits of the advertiser's currency.

For example, if the advertiser's currency is GBP (British pound sterling), all MICRO_DOLLARS fields will be in GBP microunits (1/1,000,000 British pound).

If a column has no value, it may not be returned.

granularity'TOTAL' | 'DAY' | 'HOUR' | 'WEEK' | 'MONTH' required

Specifies the time interval at which analytics data is broken down. Determines how metrics are grouped within the requested date range. Note: The HOUR enum no longer provides data for conversion metrics, but it still returns data for non-conversion metrics. All other enums are unchanged.

TOTAL - metrics are aggregated over the specified date range.

DAY - metrics are broken down daily.

HOUR - metrics are broken down hourly.

WEEK - metrics are broken down weekly.

MONTH - metrics are broken down monthly

click_window_days0 | 1 | 7 | 14 | 30 | 60

Number of days to use as the conversion attribution window for a pin click action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to 30 days.

engagement_window_days0 | 1 | 7 | 14 | 30 | 60

Number of days to use as the conversion attribution window for an engagement action. Engagements include saves, closeups, link clicks, and carousel card swipes. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to 30 days. Note: This parameter no longer returns new data. However, you can still access historic data through Sept 30, 2027.

view_window_days0 | 1 | 7 | 14 | 30 | 60

Number of days to use as the conversion attribution window for a view action. Applies to Pinterest Tag conversion metrics. Prior conversion tags use their defined attribution windows. If not specified, defaults to 1 day.

conversion_report_time'TIME_OF_AD_ACTION' | 'TIME_OF_CONVERSION'

The date by which the conversion metrics returned from this endpoint will be reported. There are two dates associated with a conversion event: the date that the user interacted with the ad, and the date that the user completed a conversion event.

Response

The request has succeeded.

DATEstring date

Current metrics date. Only returned when granularity is a time-based value (DAY, HOUR, WEEK, MONTH)

PIN_IDstring required

The ID of the pin that the metric belongs to.

Example response

[
  {
    "DATE": "2021-04-01",
    "PIN_ID": "217861700718936379",
    "SPEND_IN_DOLLAR": 30,
    "TOTAL_CLICKTHROUGH": 216
  }
]