Pinterest Ads Field Reference
Sample
The Pinterest Ads conenctor retrieves Pinterest ads data on an adveriser, campaign and pin level.
https://connectors.windsor.ai/pinterest?api_key=[your API key]&date_preset=last_7d&fields=campaign,clicks,spend,impressions,date,source,transactions,transactionrevenue
Fields
| ID | Type | Name | Description |
|---|---|---|---|
| account_id | TEXT | Account ID | Your Pinterest Advertiser ID |
| ad_group | TEXT | Ad Group | Alias for ad group name. |
| ad_group_entity_status | TEXT | Ad Group Entity Status | Your ad group entity status. |
| ad_group_id | TEXT | Ad Group ID | Your ad group ID. |
| ad_group_name | TEXT | Ad Group Name | Your ad group name. |
| ad_group_status | TEXT | Ad Group Status | Your ad group status. |
| ad_id | TEXT | Ad ID | Your ad ID. |
| adnetwork_conversions | NUMERIC | Ad Network Conversions (alias for Conversions) | Total number of conversions for all event types using the Pinterest Tag integration after an ad interaction |
| adnetwork_revenue | NUMERIC | Ad Network Revenue (alias for Total conversion value) | The value from web conversions from your promoted Pins, including both first-order and downstream, in account currency |
| advertiserid | TEXT | Advertiser ID | Your Pinterest Advertiser ID |
| campaign | TEXT | Campaign | Alias for Campaign Name |
| campaign_id | TEXT | Campaign ID | Campaign ID |
| campaign_name | TEXT | Campaign Name | Campaign Name |
| campaign_status | TEXT | Campaign Status | Campaign status ('ADVERTISER_DISABLED', 'ARCHIVED', 'COMPLETED', 'NOT_STARTED', 'PAUSED', 'RUNNING') |
| clicks | NUMERIC | Total number of Pin clicks (alias for Pin clicks) | The total number of clicks on your Pin to content on or off of Pinterest (paid and earned) |
| clickthrough | NUMERIC | Pin clicks | The total number of clicks on your Pin to content on or off of Pinterest (paid and earned) |
| clickthrough_earned | NUMERIC | Earned Pin clicks | Total number of Pin clicks from ads saved to another person's board |
| clickthrough_paid | NUMERIC | Paid Pin clicks | The total number of clicks on your Pin to content on or off of Pinterest |
| cpa | NUMERIC | CPA | The average CPA for all event types using the Pinterest Tag integration after an ad interaction |
| cpc | NUMERIC | Cost Per Click | Cost-per-click (CPC) bidding means that you pay for each click on your ads |
| cpm | NUMERIC | CPM | Cost per 1000 impressions (paid and earned) |
| ctr | PERCENT | CTR | Click-through rate of clicks on your Pin to content on or off of Pinterest (paid and earned) |
| currency | TEXT | Currency | Account currency |
| date | DATE | Date | Date |
| engagement_earned | NUMERIC | Earned engagements | Earned actions from ads saved to boards |
| engagement_paid | NUMERIC | Paid engagements | Paid actions taken as a result of your ads |
| engagements | NUMERIC | Engagements (alias for Total Engagements) | The total number of engagements on your ads, including clicks, saves, carousel swipes, and collections secondary saves |
| frequency | NUMERIC | Frequency | The average number of times each user saw your ad. |
| impressions | NUMERIC | Impressions | Number of times someone saw your ad (paid and earned) |
| impressions_earned | NUMERIC | Earned impressions | Total number of times your ad was viewed after being saved to another person's board |
| impressions_paid | NUMERIC | Paid impressions | The number of times your ad was seen |
| outbound_clicks | NUMERIC | Outbound clicks | The total number of clicks to the destination URL associated with your ad (paid and earned) |
| outbound_clicks_earned | NUMERIC | Earned outbound clicks | The total number of clicks to the destination URL associated with your ad saved to another person's board |
| outbound_clicks_paid | NUMERIC | Paid outbound clicks | The total number of clicks to the destination URL associated with your ad |
| pin_promotion_id | TEXT | Pin Promotion ID | Your ad ID. |
| pin_promotion_name | TEXT | Ad name | Name of your ad |
| pin_promotion_status | TEXT | Ad Status | Ad status ('ACTIVE', 'OTHER', 'PAUSED') |
| reach | NUMERIC | User Reach | Total number of unique users who saw your ads |
| roas | PERCENT | ROAS | The average ROAS from web conversions from your promoted Pins, including both first-order and downstream, in account currency |
| spend | NUMERIC | Spend | The money you spend for promoted Pins, in account currency |
| total_add_to_cart | NUMERIC | Conversions (Add to cart) | Total number of add to cart events resulting from interactions with your ad |
| total_add_to_cart_value | NUMERIC | Conversion value (Add to cart) | Total value of add to cart events resulting from interactions with your ad, in account currency |
| total_checkout | NUMERIC | Conversions (Checkout) | Total number of checkout events resulting from interactions with your ad |
| total_checkout_value | NUMERIC | Conversion value (Checkout) | Total value of checkout events resulting from interactions with your ad, in account currency |
| total_click_add_to_cart | NUMERIC | Click-through conversions (Add to cart) | The number of add to cart events resulting from clicks on your ad |
| total_click_add_to_cart_value | NUMERIC | Click-through conversion value (Add to cart) | Total value of add to cart events resulting from clicks on your ad, in account currency |
| total_click_checkout | NUMERIC | Click-through conversions (Checkout) | The number of checkout events resulting from clicks on your ad |
| total_click_checkout_value | NUMERIC | Click-through conversion value (Checkout) | Total value of checkout events resulting from clicks on your ad, in account currency |
| total_click_checkout_value_micros | NUMERIC | Click-through conversion value (Checkout) in micros | Total value of checkout events resulting from clicks on your ad, in micros of account currency |
| total_click_custom | NUMERIC | Click-through conversions (Custom) | The number of custom events resulting from clicks on your ad |
| total_click_custom_value | NUMERIC | Click-through conversion value (Custom) | Total value of custom events resulting from clicks on your ad, in account currency |
| total_click_lead | NUMERIC | Click-through conversions (Lead) | The number of lead events resulting from clicks on your ad |
| total_click_lead_value | NUMERIC | Click-through conversion value (Lead) | Total value of lead events resulting from clicks on your ad, in account currency |
| total_click_page_visit | NUMERIC | Click-through conversions (Page visit) | The number of page visit events resulting from clicks on your ad |
| total_click_page_visit_value | NUMERIC | Click-through conversion value (Page visit) | Total value of page visit events resulting from clicks on your ad, in account currency |
| total_click_search | NUMERIC | Click-through conversions (Website search) | The number of website search events resulting from clicks on your ad |
| total_click_search_value | NUMERIC | Click-through conversion value (Website search) | Total value of website search events resulting from clicks on your ad, in account currency |
| total_click_signup | NUMERIC | Click-through conversions (Signup) | The number of signup events resulting from clicks on your ad |
| total_click_signup_value | NUMERIC | Click-through conversion value (Signup) | Total value of signup events resulting from clicks on your ad, in account currency |
| total_click_view_category | NUMERIC | Click-through conversions (Category view) | The number of category view events resulting from clicks on your ad |
| total_click_view_category_value | NUMERIC | Click-through conversion value (Category view) | Total value of category view events resulting from clicks on your ad, in account currency |
| total_click_watch_video | NUMERIC | Click-through conversions (Watch video) | The number of watch video events resulting from clicks on your ad |
| total_click_watch_video_value | NUMERIC | Click-through conversion value (Watch video) | Total value of watch video events resulting from clicks on your ad, in account currency |
| total_conversions | NUMERIC | Conversions | Total number of conversions for all event types using the Pinterest Tag integration after an ad interaction |
| total_conversions_value | NUMERIC | Total conversion value | The value from web conversions from your promoted Pins, including both first-order and downstream, in account currency |
| total_custom | NUMERIC | Conversions (Custom) | Total number of custom events resulting from interactions with your ad |
| total_custom_value | NUMERIC | Conversion value (Custom) | Total value of custom events resulting from interactions with your ad, in account currency |
| total_engagement | NUMERIC | Total engagements | The total number of engagements on your ads, including clicks, saves, carousel swipes, and collections secondary saves |
| total_engagement_add_to_cart | NUMERIC | Engagement conversions (Add to cart) | Total number of add to cart events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_add_to_cart_value | NUMERIC | Engagement value (Add to cart) | Total value of add to cart events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_checkout | NUMERIC | Engagement conversions (Checkout) | Total number of checkout events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_checkout_value | NUMERIC | Engagement value (Checkout) | Total value of checkout events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_custom | NUMERIC | Engagement conversions (Custom) | Total number of custom events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_custom_value | NUMERIC | Engagement value (Custom) | Total value of custom events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_lead | NUMERIC | Engagement conversions (Lead) | Total number of lead events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_lead_value | NUMERIC | Engagement value (Lead) | Total value of lead events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_page_visit | NUMERIC | Engagement conversions (Page visit) | Total number of page visit events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_page_visit_value | NUMERIC | Engagement value (Page visit) | Total value of page visit events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_search | NUMERIC | Engagement conversions (Website search) | Total number of website search events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_search_value | NUMERIC | Engagement value (Website search) | Total value of website search events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_signup | NUMERIC | Engagement conversions (Signup) | Total number of signup events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_signup_value | NUMERIC | Engagement value (Signup) | Total value of signup events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_view_category | NUMERIC | Engagement conversions (Category view) | Total number of category view events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_view_category_value | NUMERIC | Engagement value (Category view) | Total value of category view events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_watch_video | NUMERIC | Engagement conversions (Watch video) | Total number of watch video events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_engagement_watch_video_value | NUMERIC | Engagement value (Watch video) | Total value of watch video events resulting from engagements with your ad. Engagements includes saves, closeups, carousel swipes, collection secondary closeups, and collection secondary saves. |
| total_lead | NUMERIC | Conversions (Lead) | Total number of lead events resulting from interactions with your ad |
| total_lead_value | NUMERIC | Conversion value (Lead) | Total value of lead events resulting from interactions with your ad, in account currency |
| total_page_visit | NUMERIC | Conversions (Page visit) | Total number of page visit events resulting from interactions with your ad |
| total_page_visit_value | NUMERIC | Conversion value (Page visit) | Total value of page visit events resulting from interactions with your ad, in account currency |
| total_search | NUMERIC | Conversions (Website search) | Total number of website search events resulting from interactions with your ad |
| total_search_value | NUMERIC | Conversion value (Website search) | Total value of website search events resulting from interactions with your ad, in account currency |
| total_signup | NUMERIC | Conversions (Signup) | Total number of signup events resulting from interactions with your ad |
| total_signup_value | NUMERIC | Conversion value (Signup) | Total value of signup events resulting from interactions with your ad, in account currency |
| total_video_75_combined | NUMERIC | Total video played at 75% | Total number of times your video ad played 75% of its length, including views that skipped ahead to this point (paid and earned) |
| total_video_p0_combined | NUMERIC | Total video starts | Total number of times your video ad started playing (paid and earned) |
| total_video_p100_complete | NUMERIC | Total video played at 100% | Total number of times your video ad played 100% of its length, including views that skipped ahead to this point (paid and earned) |
| total_video_p25_combined | NUMERIC | Total video played at 25% | Total number of times your video ad played 25% of its length, including views that skipped ahead to this point (paid and earned) |
| total_video_p50_combined | NUMERIC | Total video played at 50% | Total number of times your video ad played 50% of its length, including views that skipped ahead to this point (paid and earned) |
| total_video_p95_combined | NUMERIC | Total video played at 95% | Total number of times your video ad played 95% of its length, including views that skipped ahead to this point (paid and earned) |
| total_video_views | NUMERIC | Total video views. | Total video views. |
| total_view_add_to_cart | NUMERIC | View-through conversions (Add to cart) | Total number of add to cart events resulting from views of your ad |
| total_view_add_to_cart_value | NUMERIC | View-through conversion value (Add to cart) | Total value of add to cart events resulting from views of your ad, in account currency |
| total_view_category | NUMERIC | Conversions (Category view) | Total number of category view events resulting from interactions with your ad |
| total_view_category_value | NUMERIC | Conversion value (Category view) | Total value of category view events resulting from interactions with your ad, in account currency |
| total_view_checkout | NUMERIC | View-through conversions (Checkout) | Total number of checkout events resulting from views of your ad |
| total_view_checkout_value | NUMERIC | View-through conversion value (Checkout) | Total value of checkout events resulting from views of your ad, in account currency |
| total_view_checkout_value_micros | NUMERIC | View-through conversion value (Checkout) in micros | Total value of checkout events resulting from views of your ad, in micros of account currency |
| total_view_custom | NUMERIC | View-through conversions (Custom) | Total number of custom events resulting from views of your ad |
| total_view_custom_value | NUMERIC | View-through conversion value (Custom) | Total value of custom events resulting from views of your ad, in account currency |
| total_view_lead | NUMERIC | View-through conversions (Lead) | Total number of lead events resulting from views of your ad |
| total_view_lead_value | NUMERIC | View-through conversion value (Lead) | Total value of lead events resulting from views of your ad, in account currency |
| total_view_page_visit | NUMERIC | View-through conversions (Page visit) | Total number of page visit events resulting from views of your ad |
| total_view_page_visit_value | NUMERIC | View-through conversion value (Page visit) | Total value of page visit events resulting from views of your ad, in account currency |
| total_view_search | NUMERIC | View-through conversions (Website search) | Total number of website search events resulting from views of your ad |
| total_view_search_value | NUMERIC | View-through conversion value (Website search) | Total value of website search events resulting from views of your ad, in account currency |
| total_view_signup | NUMERIC | View-through conversions (Signup) | Total number of signup events resulting from views of your ad |
| total_view_signup_value | NUMERIC | View-through conversion value (Signup) | Total value of signup events resulting from views of your ad, in account currency |
| total_view_view_category | NUMERIC | View-through conversions (Category view) | Total number of category view events resulting from views of your ad |
| total_view_view_category_value | NUMERIC | View-through conversion value (Category view) | Total value of category view events resulting from views of your ad, in account currency |
| total_view_watch_video | NUMERIC | View-through conversions (Watch video) | Total number of watch video events resulting from views of your ad |
| total_view_watch_video_value | NUMERIC | View-through conversion value (Watch video) | Total value of watch video events resulting from views of your ad, in account currency |
| total_watch_video | NUMERIC | Conversions (Watch video) | Total number of watch video events resulting from interactions with your ad |
| total_watch_video_value | NUMERIC | Conversion value (Watch video) | Total value of watch video events resulting from interactions with your ad, in account currency |
| totalcost | NUMERIC | Total Cost | The money you spend for promoted Pins, in account currency |
| transactionrevenue | NUMERIC | Transaction Revenue (alias for Total conversion value) | The value from web conversions from your promoted Pins, including both first-order and downstream, in account currency |
| transactions | NUMERIC | Transactions (alias for Conversions) | Total number of conversions for all event types using the Pinterest Tag integration after an ad interaction |
| video_p0_combined_earned | NUMERIC | Earned video starts | Total number of times your video ad started playing after it was saved to another person's board |
| video_p0_combined_paid | NUMERIC | Paid video starts | Number of times your video ad started playing |
| video_p100_complete_earned | NUMERIC | Earned video played at 100% | Total number of times your video ad reached 100% of its length after it was saved to another person's board, including views that skipped ahead to this point |
| video_p100_complete_paid | NUMERIC | Paid video played at 100% | Number of times your video ad reached 100% of its length, including views that skipped ahead to this point |
| video_p25_combined_earned | NUMERIC | Earned video played at 25% | Total number of times your video ad reached 25% of its length after it was saved to another person's board, including views that skipped ahead to this point |
| video_p25_combined_paid | NUMERIC | Paid video played at 25% | Number of times your video ad reached 25% of its length, including views that skipped ahead to this point |
| video_p50_combined_earned | NUMERIC | Earned video played at 50% | Total number of times your video ad reached 50% of its length after it was saved to another person's board, including views that skipped ahead to this point |
| video_p50_combined_paid | NUMERIC | Paid video played at 50% | Number of times your video ad reached 50% of its length, including views that skipped ahead to this point |
| video_p75_combined_earned | NUMERIC | Earned video played at 75% | Total number of times your video ad reached 75% of its length after it was saved to another person's board, including views that skipped ahead to this point |
| video_p75_combined_paid | NUMERIC | Paid video played at 75% | Number of times your video ad reached 75% of its length, including views that skipped ahead to this point |
| video_p95_combined_earned | NUMERIC | Earned video played at 95% | Total number of times your video ad reached 95% of its length after it was saved to another person's board, including views that skipped ahead to this point |
| video_p95_combined_paid | NUMERIC | Paid video played at 95% | Number of times your video ad reached 95% of its length, including views that skipped ahead to this point |