AdAnalytics
Get analytics for the ads in the specified AdAccountId
Table Specific Information
Select
The cmdlet will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the cmdlet.
- AdAccountId supports the '=' operator.
- AdId supports the '=,IN' operator.
- StartDate supports the '=,>,>=' operator.
- EndDate supports the '=,<,<=' operator.
- Granularity supports the '=' operator.
- ClickWindowDays supports the '=' operator.
- EngagementWindowDays supports the '=' operator.
- ViewWindowDays supports the '=' operator.
- ConversionReportTime supports the '=' operator.
SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'
SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
| Name | Type | References | Description |
| AdId | String |
Ads.Id | Id of the ad |
| AdAccountId | String |
AdAccounts.Id | Id of the ad account |
| Date | Date | Current metrics date. Only returned when granularity is a time-based value. | |
| CampaignEntityStatus | String | Status of the campaign. | |
| AdGroupEntityStatus | String | Status of the ad group. | |
| SpendInDollar | Double | Total spend in dollars. | |
| EcpcInDollar | Double | Ecpc in dollars. | |
| Ctr | Double | Ctr. | |
| Ectr | Double | Ectr. | |
| EcpeInDollar | Double | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| RepinRate | Double | The repin rate. | |
| Ctr2 | Double | Ctr2 | |
| CpmInDollar | Double | Cpm in Dollars. | |
| WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
| WebCheckoutRoas | Double | Web checkout roas | |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| CheckoutRoas | Double | Checkout roas. | |
| Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
| VideoP100Complete2 | Integer | Videos 100 percent complete | |
| VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
| VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
| VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
| VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
| VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
| VideoMrcViews2 | Integer | Video Mrc Views. | |
| EcpvInDollar | Double | Ecpv in dollars. | |
| EcpcvInDollar | Double | E Cpcv in Dollars | |
| EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| TotalImpressionFrequency | Double | Total Impression Frequency. | |
| TotalEngagementSignup | Integer | Total Engagement Signup. | |
| TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
| TotalClickSignup | Integer | Total Click Signup. | |
| TotalClickCheckout | Integer | Total Click Checkout. | |
| TotalViewSignup | Integer | Total View Signup. | |
| TotalViewCheckout | Integer | Total View Checkout. | |
| TotalConversions | Integer | Total Conversions. | |
| TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
| TotalVideo3secViews | Integer | Total Video 3 second Views. | |
| TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
| TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
| TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
| TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
| TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
| TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
| TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
| TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
| TotalRepinRate | Double | Total Repin Rate. | |
| TotalWebCheckout | Integer | Total Web Checkout. | |
| TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| AdvertiserId | String | Id of the ad account | |
| AdGroupId | String |
AdGroups.Id | Id of the ad group. |
| CampaignDailySpendCap | Integer | Campaign daily spend cap. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| CampaignName | String | Name of the Campaign | |
| Clickthrough2 | Integer | Clickthrough2. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| Impression2 | Integer | Impression2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PaidImpression | Integer | PaidImpression. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| SpendInMicroDollar | Decimal | Total spend in dollars. | |
| TotalClickAddToCart | Integer | Total click add to cart. | |
| TotalClickLead | Integer | Total click lead. | |
| TotalCustom | Integer | Total custom. | |
| TotalEngagement | Integer | Total Engagement. | |
| TotalEngagementLead | Integer | Total Engagement Lead. | |
| TotalIdeaPinProductTagVisit | Integer | Total Idea Pin Product Tag Visit. | |
| TotalImpressionUser | Integer | Total Impression User. | |
| TotalLead | Integer | Total Lead. | |
| TotalOfflineCheckout | Integer | Total offline checkout. | |
| TotalViewAddToCart | Integer | Total view add to cart. | |
| TotalViewLead | Integer | Total view Lead. | |
| TotalWebSessions | Integer | Total web sessions. | |
| VideoLength | Integer | VideoLength. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | Granularity
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION. The default value is TIME_OF_AD_ACTION. |