Pinterest Raw Data Guide
This guide shows you how to use the raw data coming from this specific data source APIs, so we can support you achieve your reporting needs. In this guide, some recommendations are provided as well as examples of use cases for the most commonly used fields. If you’d like to dig deeper into the raw data from each API, we recommend you to refer to our integrations documentation which provides links to each API documentation. For more guidance on how to build your reports and BI metrics, please inquire us about the Beginners Journey, Data Modelling Guide, Marketing Attribution and/or BI Metrics Guide.
Note: There may be several ways to achieve the use cases that has been indicated below, but these columns are the ones commonly used for most of the use cases we've encountered.
Most Used Tables
Table Name |
Description |
campaign_delivery_metrics |
Returns delivery metrics for a campaign |
pin_promotion_delivery_metrics |
Returns delivery metrics for a pin promotion. |
ad_group_pin_promotions |
Returns all pin promotion objects for an ad group.
|
Most Used Fields
Column Name |
Description |
Use Cases |
Table Name |
name | Pin promotion name | Entity field/ Dimension to breakdown your metrics by different Pin promotions | ad_group_pin_promotions |
pin_id | The ID of the pin | Use for breaking down your ads metrics by the pin | ad_group_pin_promotions |
ad_group_id | The ID of the Ad group. | Use for breaking down your ads metrics by the ad group | ad_group_pin_promotions |
campaign_id | The ID of the campaign | Entity field/ Dimension to breakdown your metrics by different campaigns, or join metrics on each unique campaign | ad_group_pin_promotions |
created_time | The autogenerated date and time when the ad was created. | For analyzing ad performance overtime, grouping by metrics by time frames, or joining on sales data for a daily summary analysis and other advanced ananlysis. | ad_group_pin_promotions |
campaign_name | The name of the ad Campaign. | Entity field/ Dimension to breakdown your metrics by different campaigns | campaign_delivery_metrics, ad_group_pin_promotions |
day | The date formatted as yyyy-MM-dd | For analyzing ad performance overtime, grouping by metrics by time frames, or joining on sales data for a daily summary analysis and other advanced ananlysis. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
IMPRESSION_1 | Metric names ending in _1 represent first order ad events. For example, IMPRESSION_1 is the number of views/impressions on a Promoted Pin. | Metric field to be used for calculating the CTR, among other conversion rates. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
IMPRESSION_2 | Metric names ending in _2 represent downstream (“earned”) events. These are actions taken on saved instances of Promoted Pins. Advertisers are not billed for earned activity. | Metric field to be used for calculating the CTR, among other conversion rates. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
CLICKTHROUGH_1 | Metric names ending in _1 represent first order ad events. For example, CLICKTHROUGH_1 is the number of direct clicks on a Promoted Pin. | Metric field to be used for calculating the CTR, among other conversion rates. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
CLICKTHROUGH_2 | Metric names ending in _2 represent downstream (“earned”) events. These are actions taken on saved instances of Promoted Pins. Advertisers are not billed for earned activity. | Metric field to be used for calculating the CTR, among other conversion rates. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
TOTAL_CONVERSIONS | Metrics that begin with TOTAL refer to conversion data. TOTAL_CONVERSIONS is total number of conversions for the requested reporting period. If you are passing order quantity and order value in Pinterest Tag conversion events, these totals will show in TOTAL_CONVERSIONS_QUANTITY and TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR. | Metric field to be used for calculating the CVR, among other conversion rates, as well as CPC and so on. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR | Metrics that begin with TOTAL refer to conversion data. TOTAL_CONVERSIONS is total number of conversions for the requested reporting period. If you are passing order quantity and order value in Pinterest Tag conversion events, these totals will show in TOTAL_CONVERSIONS_QUANTITY and TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR. | Metric field to be used for calculating the ROI, CPC, and so on. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
TOTAL_CONVERSIONS_QUANTITY | Metrics that begin with TOTAL refer to conversion data. TOTAL_CONVERSIONS is total number of conversions for the requested reporting period. If you are passing order quantity and order value in Pinterest Tag conversion events, these totals will show in TOTAL_CONVERSIONS_QUANTITY and TOTAL_CONVERSIONS_VALUE_IN_MICRO_DOLLAR. | Metric field to be used for calculating the CVR, among other conversion rates, as well as CPC and so on. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
SPEND_IN_MICRO_DOLLAR | It represents the spend in the micro currency (millionth of a currency unit) of the Advertiser. | Metric field that measures the amount you spent on avertising, for calculating ROAS, etc. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
OUTBOUND_CLICK_1 | Paid outbound clicks | Metric field that measures the amount of clicks generated by a paid pin | campaign_delivery_metrics |
REPIN_1 | Metric names ending in _1 represent first order ad events. For example, REPIN_1 is the number of direct clicks on a Promoted Pin. | Repins are used by Pinterest’s algorithm to determine which Pins are popular. This metric can support detecting most popular paid pins. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
REPIN_2 | Metric names ending in _2 represent downstream (“earned”) events. These are actions taken on saved instances of Promoted Pins. Advertisers are not billed for earned activity. | Repins are used by Pinterest’s algorithm to determine which Pins are popular. This metric can support detecting most popular paid pins. | campaign_delivery_metrics, pin_promotion_delivery_metrics |
PIN_PROMOTION_ID | The ID of the Pin Promotion | Entity field/ Dimension to breakdown your metrics by different Pin promotions, or join metrics on each unique pin promotion | pin_promotion_delivery_metrics |
PIN_PROMOTION_CAMPAIGN_ID | The ID of the Pin Promotion Campaign | Entity field/ Dimension to breakdown your metrics by different campaigns, or join metrics on each unique campaign | pin_promotion_delivery_metrics |