Get ads analytics
pinterest_ads_get_analyticsRetrieve synchronous Pinterest Ads metrics for an ad account or up to 250 campaigns, ad groups, ads, or product groups without changing data.
Instructions
Get ads metrics right away (synchronous) for the ad account, or for up to 250 campaigns, ad groups, ads or product groups. Changes nothing.
level: account, campaign, ad_group, ad or product_group (ids required except for account). Dates are YYYY-MM-DD. granularity: TOTAL, DAY, WEEK, MONTH or HOUR. targeting_types breaks results down by targeting, e.g. ['LOCATION'], ['KEYWORD'], ['AGE_BUCKET_AND_GENDER'] (not for product groups). Attribution windows default to Pinterest's (30-day click and engagement, 1-day view); conversion_report_time TIME_OF_AD_ACTION (default) or TIME_OF_CONVERSION; reporting_timezone PINTEREST_TIME_ZONE (UTC, default) or AD_ACCOUNT_TIME_ZONE.
Common columns: SPEND_IN_DOLLAR (account currency, despite the name), PAID_IMPRESSION, IMPRESSION_1, CLICKTHROUGH_1 (Pin clicks), OUTBOUND_CLICK_1, CTR, OUTBOUND_CTR_1, CPC_IN_MICRO_DOLLAR, CPM_IN_DOLLAR, TOTAL_ENGAGEMENT, TOTAL_CONVERSIONS, TOTAL_CHECKOUT, TOTAL_CHECKOUT_VALUE_IN_MICRO_DOLLAR, CHECKOUT_ROAS, TOTAL_ADD_TO_CART, TOTAL_LEAD, TOTAL_SIGNUP, CAMPAIGN_NAME, CAMPAIGN_ID. _1 metrics are paid, _2 earned (saves of ads). pinterest_ads_list_metrics lists every column with its definition. HOUR granularity no longer includes conversion metrics.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ids | No | ||
| level | Yes | ||
| columns | Yes | ||
| end_date | Yes | ||
| start_date | Yes | ||
| granularity | No | TOTAL | |
| ad_account_id | No | ||
| targeting_types | No | ||
| view_window_days | No | ||
| attribution_types | No | ||
| click_window_days | No | ||
| reporting_timezone | No | ||
| conversion_report_time | No | ||
| engagement_window_days | No |