v29

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

Get targeting analytics for an ad account

Get targeting analytics for an ad account. For the requested account and metrics, the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type (e.g. "age_bucket") for applicable values (e.g. "45-49"). <p/>

  • 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, you can pull data from up to 90 days before the current date in UTC time, with a maximum time range of 90 days.
  • If granularity is HOUR, you can pull data from up to 8 days before the current date in UTC time, with a maximum time range of 3 days.
get/ad_accounts/{ad_account_id}/targeting_analytics

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

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.

targeting_typesAdsAnalyticsAccountTargetingType[] required

Targeting type breakdowns for the report. The reporting per targeting type is independent from each other. ["AGE_BUCKET_AND_GENDER"] is in BETA and not yet available to all users.

[
  "APPTYPE"
]
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.

attribution_typesConversionReportAttributionType[]

List of types of attribution for the conversion report

[
  "INDIVIDUAL"
]
reporting_timezone'PINTEREST_TIME_ZONE' | 'AD_ACCOUNT_TIME_ZONE'

Specify the timezone to be applied for the reporting.

Example:PINTEREST_TIME_ZONE

Specify the timezone to be applied for the reporting. This feature is currently in BETA and is not available to all users.

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "targeting_type": "KEYWORD",
      "targeting_value": "christmas decor ideas",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "iphone",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "ipad",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "web",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "web_mobile",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "android_mobile",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "APPTYPE",
      "targeting_value": "android_tablet",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "GENDER",
      "targeting_value": "female",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "LOCATION",
      "targeting_value": "500",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "PLACEMENT",
      "targeting_value": "SEARCH",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "COUNTRY",
      "targeting_value": "US",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "TARGETED_INTEREST",
      "targeting_value": "Food and Drinks",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "PINNER_INTEREST",
      "targeting_value": "Chocolate Cookies",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "AUDIENCE_INCLUDE",
      "targeting_value": "254261234567",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "GEO",
      "targeting_value": "US:94102",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "AGE_BUCKET",
      "targeting_value": "45-49",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    },
    {
      "targeting_type": "REGION",
      "targeting_value": "US-CA",
      "metrics": {
        "AD_GROUP_ID": 2680067996745,
        "DATE": "2022-04-26",
        "SPEND_IN_DOLLAR": 240
      }
    }
  ]
}