CData Cloud offers access to Pinterest across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Pinterest through CData Cloud.
CData Cloud allows you to standardize and configure connections to Pinterest as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Pinterest in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Pinterest and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Pinterest through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Pinterest by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
The following subsections describe how to authenticate to Pinterest from three common authentication flows:
For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.
For a complete list of connection string properties available in Pinterest, see Connection.
Automatic refresh of the OAuth access token:
To have the Cloud automatically refresh the OAuth access token:
Manual refresh of the OAuth access token:
The only value needed to manually refresh the OAuth access token is the OAuth refresh token.
Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.
When application creation is complete, the Developers Portal displays a confirmation message. To reveal the new custom application's Client ID and Client Secret, click View Client ID.
Record these settings for future use.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Pinterest APIs.
Views describes the available views. Views are statically defined to model ... here will go view names.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AdAccountAnalytics | Get analytics for the specified AdAccountId |
| AdAccountAnalyticsReport | Get the ad account analytics report |
| AdAccounts | Get a list of the ad_accounts that the User has access to. |
| AdAccountTargetingAnalytics | Get targeting analytics for an ad account. |
| AdAnalytics | Get analytics for the ads in the specified AdAccountId |
| AdCampaignAnalytics | Get analytics for the specified campaigns in the specified AdAccountId |
| AdGroupAnalytics | Get analytics for the ad groups in the specified AdAccountId |
| AdGroupPreview | Query records for one or more ad groups. Returns all active previews associated with the provided ad group IDs. Each ad group is processed independently; individual failures do not block other previews. |
| AdGroups | Get a list of the ad_accounts that the User has access to. |
| AdGroupTargetingAnalytics | Get targeting analytics for one or more ad groups. |
| Ads | Get a list of the ad_accounts that the User has access to. |
| AdsCreditDiscounts | Returns the list of ads credit discounts applied to the specified ad account. |
| AdsTargetingAnalytics | Get targeting analytics for one or more ads. |
| AdvertiserDefinedEvents | Get advertiser defined events for the given ad account. |
| AudienceInsights | Get Audience Insights for an ad account. |
| AudienceInsightsScopeAndType | Get the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction on pins. |
| Audiences | Returns a list of audiences for the ad account. |
| BillingInvoices | Get billing invoices in the advertiser account. |
| BillingProfiles | Get billing profiles in the advertiser account. |
| Boards | Get a list of the boards owned by the User |
| BoardSections | Get a list of the boards owned by the User |
| BusinessAssets | Get all the assets the requesting business has access to, including assets the business owns and assets accessed through partnerships. |
| Campaigns | Get account information for the operation user_account |
| CampaignTargetingAnalytics | Get targeting analytics for one or more campaign. |
| CatalogHotelReport | Returns the hotel catalog processing report with status, run timestamps, item counts, and error summaries. |
| CatalogProcessingResultItemIssues | Returns item-level issues detected during catalog processing. |
| CatalogRetailReport | Returns the retail catalog processing report with status, run timestamps, item counts, and error summaries. |
| Catalogs | Returns catalogs owned by the user account associated with the operation. |
| CatalogTypeCreativeAssetsItems | Retrieve the items from the catalog that are classified as CREATIVE_ASSETS and are owned by the user account associated with the operation. |
| CatalogTypeHotelItems | Retrieve items from the operating user's HOTEL catalog. |
| CatalogTypeRetailItems | Retrieve items from the retail catalog owned by the operating user account. |
| ConversionTags | Get information about the conversion tags in an ad account. |
| CustomerLists | Get a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience. |
| CustomerListUpload | Get the metadata for a customer list upload by its ID. |
| EditorialArticles | Get a list of published editorial articles for a given region. Translations are provided when available; otherwise the default language is English. |
| FeaturedTopics | Pull the top trending topics by interest and market, at full parity with the Pinterest Trends UI. |
| FeaturedTopicsTrends | Get the individual trending topics within the featured topics for a given interest and market. Child view of FeaturedTopics. |
| FeedProcessingResults | Returns processing results for feeds, including status, run timestamps, item counts, and error summaries. |
| Feeds | Returns feeds owned by the user account associated with the operation. |
| Followers | Get a list of your followers. |
| Following | Get a list of your followers. |
| FollowingBoards | Get a list of the boards a user follows. |
| Labels | See a list of labels for assets that your account owns, filtered by different criteria. If no filter is provided, it defaults to labels associated with the ad account. |
| LinkedBusinesses | Get a list of your linked business accounts. |
| LocalStores | Query local stores for a catalog owned by the operation user account. |
| MediaUploads | List media uploads owned by the operation user account. |
| OrderLines | Get the order lines associated with an ad account. |
| PinAnalytics | Get analytics for a Pin owned by the operation user account, or on a group board shared with this account. |
| Pins | Get a Pin owned by the owned by the User or on a group board that has been shared with this account |
| ProductCategoryDetails | Retrieve demographic information, related pins, and trend lines for specified product categories. |
| ProductGroupAnalytics | Get targeting analytics for one or more campaign. |
| ProductGroups | Get a list of product groups for a given catalog feed owned by the operation user account. |
| Promotions | Gets all promotions associated with an ad account ID that can be applied to an ad group. |
| TargetingTypeAgeBucket | Get a list of the age bucket which are available inside the targets. |
| TargetingTypeAppType | Get a list of the app type which are available inside the targets. |
| TargetingTypeAudienceExclude | Returns a list of audience exclusion targeting options available for ad targeting. |
| TargetingTypeAudienceInclude | Returns a list of audience inclusion targeting options available for ad targeting. |
| TargetingTypeGender | Get a list of the gender which are available inside the targets. |
| TargetingTypeGeo | Get a list of the geo which are available inside the targets. |
| TargetingTypeInterests | Get a list of the interest which are available inside the targets. |
| TargetingTypeKeyword | Returns a list of keyword targeting options available for ad targeting. |
| TargetingtypeLocale | Get a list of the locale which are available inside the targets. |
| TargetingTypeLocations | Get a list of the location which are available inside the targets. |
| TrendingProductCategories | Get a list of growing shopping product categories in ranked order, with filtering by engagement type, vertical, age, and gender. |
| UserAccount | Get account information for the operation User Account |
| UserAccountDailyMetrics | Get Daily Metric of User Account |
| UserAccountSummaryMetrics | Get Summary Metric of User Account |
| UserAccountTopVideoPinAnalytics | Get analytics data about a user's top pins. |
| UserTopPinAnalytics | Get analytics data about a user's top pins. |
| UserVerificationCodeForWebsiteClaim | Get verification code for user to install on the website to claim it. |
| UserWebsites | Get user websites, claimed or not. |
Get analytics for the specified AdAccountId
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
For example:
SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| 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. | |
| AdId | String |
Ads.Id | Id of the Ad. |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CostPerPaidOutboundClickInDollar | Double | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Double | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | Granularity
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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. |
Get the ad account analytics report
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | = |
| EndDate | = |
| Granularity | = |
| Level | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
| AttributionTypes | = |
| CampaignIds | =, IN |
| CampaignStatuses | =, IN |
| CampaignObjectiveTypes | = |
| AdGroupIds | =, IN |
| AdGroupStatuses | = |
| AdIds | =, IN |
| AdStatuses | = |
| ProductGroupIds | =, IN |
| ProductGroupStatuses | =, IN |
| TargetingTypes | =, IN |
| ProductItemIds | =, IN |
For example:
SELECT * FROM AdAccountAnalyticsReport WHERE AdAccountId = '3457832451' AND Level = 'advertiser'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | Id of the ad account. |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | Granularity.
The allowed values are TOTAL, DAY, WEEK, MONTH. | |
| Level | String | Level of the report.
The allowed values are ADVERTISER, ADVERTISER_TARGETING, CAMPAIGN, CAMPAIGN_TARGETING, AD_GROUP, AD_GROUP_TARGETING, PIN_PROMOTION, PIN_PROMOTION_TARGETING, KEYWORD, PRODUCT_GROUP, PRODUCT_GROUP_TARGETING, PRODUCT_ITEM, PRODUCT_ITEM_TARGETING. The default value is ADVERTISER. | |
| AdGroupEntityStatus | String | ||
| AdGroupId | String | ||
| AdGroupName | String | ||
| AdGroupStatus | String | ||
| AdId | String | ||
| AdName | String | ||
| AdStatus | String | ||
| AdvertiserId | String | ||
| APPINSTALLCOSTPERACTION | Integer | ||
| CAMPAIGNDAILYSPENDCAP | Integer | ||
| CAMPAIGNENTITYSTATUS | String | ||
| CAMPAIGNID | String | ||
| CAMPAIGNLIFETIMESPENDCAP | Integer | ||
| CAMPAIGNMANAGEDSTATUS | String | ||
| CAMPAIGNNAME | String | ||
| CAMPAIGNSTATUS | String | ||
| CHECKOUTROAS | String | ||
| CLICKTHROUGH1 | Integer | ||
| CLICKTHROUGH1GROSS | Integer | ||
| CLICKTHROUGH2 | Integer | ||
| CPCINMICRODOLLAR | Integer | ||
| CPCVINMICRODOLLAR | Integer | ||
| CPCVP95INMICRODOLLAR | Integer | ||
| CPMINDOLLAR | Integer | ||
| CPMINMICRODOLLAR | Integer | ||
| CPVINMICRODOLLAR | Integer | ||
| CTR | Integer | ||
| CTR2 | Integer | ||
| ECPCINDOLLAR | Integer | ||
| ECPCINMICRODOLLAR | Integer | ||
| ECPCVINDOLLAR | Integer | ||
| ECPCVP95INDOLLAR | Integer | ||
| ECPEINDOLLAR | Integer | ||
| ECPMINMICRODOLLAR | Integer | ||
| ECPVINDOLLAR | Integer | ||
| ECTR | Integer | ||
| EENGAGEMENTRATE | Integer | ||
| ENGAGEMENT1 | Integer | ||
| ENGAGEMENT2 | Integer | ||
| ENGAGEMENTRATE | Integer | ||
| IDEAPINPRODUCTTAGVISIT1 | String | ||
| IDEAPINPRODUCTTAGVISIT2 | String | ||
| IMPRESSION1 | Integer | ||
| IMPRESSION1GROSS | Integer | ||
| IMPRESSION2 | Integer | ||
| INAPPADDTOCARTCOSTPERACTION | Integer | ||
| INAPPADDTOCARTROAS | String | ||
| INAPPAPPINSTALLCOSTPERACTION | Integer | ||
| INAPPAPPINSTALLROAS | String | ||
| INAPPCHECKOUTCOSTPERACTION | Integer | ||
| INAPPCHECKOUTROAS | String | ||
| INAPPSEARCHCOSTPERACTION | Integer | ||
| INAPPSEARCHROAS | String | ||
| INAPPSIGNUPCOSTPERACTION | Integer | ||
| INAPPSIGNUPROAS | String | ||
| INAPPUNKNOWNCOSTPERACTION | Integer | ||
| INAPPUNKNOWNROAS | String | ||
| OFFLINECHECKOUTCOSTPERACTION | Integer | ||
| OFFLINECHECKOUTROAS | String | ||
| OFFLINECUSTOMCOSTPERACTION | Integer | ||
| OFFLINECUSTOMROAS | String | ||
| OFFLINELEADCOSTPERACTION | Integer | ||
| OFFLINELEADROAS | String | ||
| OFFLINESIGNUPCOSTPERACTION | Integer | ||
| OFFLINESIGNUPROAS | String | ||
| OFFLINEUNKNOWNCOSTPERACTION | Integer | ||
| OFFLINEUNKNOWNROAS | String | ||
| ONSITECHECKOUTS1 | Integer | ||
| OUTBOUNDCLICK1 | Integer | ||
| OUTBOUNDCLICK2 | Integer | ||
| PAGEVISITCOSTPERACTION | Integer | ||
| PAGEVISITROAS | String | ||
| PAIDIMPRESSION | Integer | ||
| PINID | String | ||
| PINPROMOTIONID | String | ||
| PINPROMOTIONNAME | String | ||
| PINPROMOTIONSTATUS | String | ||
| PRODUCTGROUPID | String | ||
| REPIN1 | Integer | ||
| REPIN2 | Integer | ||
| REPINRATE | String | ||
| SPENDINDOLLAR | Integer | ||
| SPENDINMICRODOLLAR | Integer | ||
| TOTALADDTOCARTDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALADDTOCARTDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALADDTOCARTDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALADDTOCARTMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALADDTOCARTMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALADDTOCARTMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALADDTOCARTTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALADDTOCARTTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALADDTOCARTTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALAPPINSTALL | Integer | ||
| TOTALAPPINSTALLDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALAPPINSTALLDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALAPPINSTALLDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALAPPINSTALLMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALAPPINSTALLMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALAPPINSTALLMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALAPPINSTALLTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALAPPINSTALLTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALAPPINSTALLTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALCHECKOUT | Integer | ||
| TOTALCHECKOUTDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCHECKOUTDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCHECKOUTDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALCHECKOUTMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCHECKOUTMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCHECKOUTMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALCHECKOUTQUANTITY | Integer | ||
| TOTALCHECKOUTTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCHECKOUTTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCHECKOUTTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKADDTOCART | Integer | ||
| TOTALCLICKADDTOCARTQUANTITY | Integer | ||
| TOTALCLICKADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKAPPINSTALL | Integer | ||
| TOTALCLICKAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKCHECKOUT | Integer | ||
| TOTALCLICKCHECKOUTQUANTITY | Integer | ||
| TOTALCLICKCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKCUSTOM | Integer | ||
| TOTALCLICKCUSTOMQUANTITY | Integer | ||
| TOTALCLICKCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKLEAD | Integer | ||
| TOTALCLICKLEADQUANTITY | Integer | ||
| TOTALCLICKLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKPAGEVISIT | Integer | ||
| TOTALCLICKPAGEVISITQUANTITY | Integer | ||
| TOTALCLICKPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKSEARCH | Integer | ||
| TOTALCLICKSEARCHQUANTITY | Integer | ||
| TOTALCLICKSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKSIGNUP | Integer | ||
| TOTALCLICKSIGNUPQUANTITY | Integer | ||
| TOTALCLICKSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKUNKNOWN | Integer | ||
| TOTALCLICKUNKNOWNQUANTITY | Integer | ||
| TOTALCLICKUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKVIEWCATEGORY | String | ||
| TOTALCLICKVIEWCATEGORYQUANTITY | Integer | ||
| TOTALCLICKVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKWATCHVIDEO | Integer | ||
| TOTALCLICKWATCHVIDEOQUANTITY | Integer | ||
| TOTALCLICKWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALCLICKTHROUGH | Integer | ||
| TOTALCONVERSIONS | Integer | ||
| TOTALCONVERSIONSQUANTITY | Integer | ||
| TOTALCONVERSIONSVALUEINMICRODOLLAR | Integer | ||
| TOTALCUSTOM | Integer | ||
| TOTALCUSTOMDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCUSTOMDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCUSTOMDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALCUSTOMMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCUSTOMMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCUSTOMMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALCUSTOMTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALCUSTOMTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALCUSTOMTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALENGAGEMENT | Integer | ||
| TOTALENGAGEMENTADDTOCART | Integer | ||
| TOTALENGAGEMENTADDTOCARTQUANTITY | Integer | ||
| TOTALENGAGEMENTADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTAPPINSTALL | Integer | ||
| TOTALENGAGEMENTAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTCHECKOUT | Integer | ||
| TOTALENGAGEMENTCHECKOUTQUANTITY | Integer | ||
| TOTALENGAGEMENTCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTCUSTOM | Integer | ||
| TOTALENGAGEMENTCUSTOMQUANTITY | Integer | ||
| TOTALENGAGEMENTCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTLEAD | Integer | ||
| TOTALENGAGEMENTLEADQUANTITY | Integer | ||
| TOTALENGAGEMENTLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTPAGEVISIT | Integer | ||
| TOTALENGAGEMENTPAGEVISITQUANTITY | Integer | ||
| TOTALENGAGEMENTPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTSEARCH | Integer | ||
| TOTALENGAGEMENTSEARCHQUANTITY | Integer | ||
| TOTALENGAGEMENTSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTSIGNUP | Integer | ||
| TOTALENGAGEMENTSIGNUPQUANTITY | Integer | ||
| TOTALENGAGEMENTSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTUNKNOWN | Integer | ||
| TOTALENGAGEMENTUNKNOWNQUANTITY | Integer | ||
| TOTALENGAGEMENTUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTVIEWCATEGORY | String | ||
| TOTALENGAGEMENTVIEWCATEGORYQUANTITY | Integer | ||
| TOTALENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALENGAGEMENTWATCHVIDEO | Integer | ||
| TOTALENGAGEMENTWATCHVIDEOQUANTITY | Integer | ||
| TOTALENGAGEMENTWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALIDEAPINPRODUCTTAGVISIT | Integer | ||
| TOTALIMPRESSIONFREQUENCY | Integer | ||
| TOTALIMPRESSIONUSER | Integer | ||
| TOTALINAPPADDTOCART | String | ||
| TOTALINAPPADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPAPPINSTALL | Integer | ||
| TOTALINAPPAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCHECKOUT | Integer | ||
| TOTALINAPPCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKADDTOCART | Integer | ||
| TOTALINAPPCLICKADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKAPPINSTALL | Integer | ||
| TOTALINAPPCLICKAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKCHECKOUT | Integer | ||
| TOTALINAPPCLICKCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKSEARCH | Integer | ||
| TOTALINAPPCLICKSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKSIGNUP | Integer | ||
| TOTALINAPPCLICKSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPCLICKUNKNOWN | Integer | ||
| TOTALINAPPCLICKUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTADDTOCART | Integer | ||
| TOTALINAPPENGAGEMENTADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTAPPINSTALL | Integer | ||
| TOTALINAPPENGAGEMENTAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTCHECKOUT | Integer | ||
| TOTALINAPPENGAGEMENTCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTSEARCH | Integer | ||
| TOTALINAPPENGAGEMENTSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTSIGNUP | Integer | ||
| TOTALINAPPENGAGEMENTSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPENGAGEMENTUNKNOWN | Integer | ||
| TOTALINAPPENGAGEMENTUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPSEARCH | Integer | ||
| TOTALINAPPSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPSIGNUP | Integer | ||
| TOTALINAPPSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPUNKNOWN | Integer | ||
| TOTALINAPPUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWADDTOCART | Integer | ||
| TOTALINAPPVIEWADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWAPPINSTALL | Integer | ||
| TOTALINAPPVIEWAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWCHECKOUT | Integer | ||
| TOTALINAPPVIEWCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWSEARCH | Integer | ||
| TOTALINAPPVIEWSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWSIGNUP | Integer | ||
| TOTALINAPPVIEWSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALINAPPVIEWUNKNOWN | String | ||
| TOTALINAPPVIEWUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALLEAD | Integer | ||
| TOTALLEADDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALLEADDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALLEADDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALLEADMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALLEADMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALLEADMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALLEADTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALLEADTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALLEADTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALOFFLINECHECKOUT | Integer | ||
| TOTALOFFLINECHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECLICKCHECKOUT | Integer | ||
| TOTALOFFLINECLICKCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECLICKCUSTOM | Integer | ||
| TOTALOFFLINECLICKCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECLICKLEAD | Integer | ||
| TOTALOFFLINECLICKLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECLICKSIGNUP | Integer | ||
| TOTALOFFLINECLICKSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECLICKUNKNOWN | Integer | ||
| TOTALOFFLINECLICKUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINECUSTOM | Integer | ||
| TOTALOFFLINECUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEENGAGEMENTCHECKOUT | Integer | ||
| TOTALOFFLINEENGAGEMENTCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEENGAGEMENTCUSTOM | Integer | ||
| TOTALOFFLINEENGAGEMENTCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEENGAGEMENTLEAD | Integer | ||
| TOTALOFFLINEENGAGEMENTLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEENGAGEMENTSIGNUP | Integer | ||
| TOTALOFFLINEENGAGEMENTSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEENGAGEMENTUNKNOWN | Integer | ||
| TOTALOFFLINEENGAGEMENTUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINELEAD | Integer | ||
| TOTALOFFLINELEADVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINESIGNUP | Integer | ||
| TOTALOFFLINESIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEUNKNOWN | Integer | ||
| TOTALOFFLINEUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEVIEWCHECKOUT | Integer | ||
| TOTALOFFLINEVIEWCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEVIEWCUSTOM | Integer | ||
| TOTALOFFLINEVIEWCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEVIEWLEAD | Integer | ||
| TOTALOFFLINEVIEWLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEVIEWSIGNUP | Integer | ||
| TOTALOFFLINEVIEWSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALOFFLINEVIEWUNKNOWN | Integer | ||
| TOTALOFFLINEVIEWUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALPAGEVISIT | Integer | ||
| TOTALPAGEVISITDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALPAGEVISITDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALPAGEVISITDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALPAGEVISITMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALPAGEVISITMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALPAGEVISITMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALPAGEVISITTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALPAGEVISITTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALPAGEVISITTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALREPINRATE | Integer | ||
| TOTALSEARCHDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSEARCHDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSEARCHDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSEARCHMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSEARCHMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSEARCHMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSEARCHTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSEARCHTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSEARCHTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSIGNUP | Integer | ||
| TOTALSIGNUPDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSIGNUPDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSIGNUPDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSIGNUPMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSIGNUPMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSIGNUPMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSIGNUPTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALSIGNUPTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALSIGNUPTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALUNKNOWNDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALUNKNOWNDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALUNKNOWNDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALUNKNOWNMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALUNKNOWNMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALUNKNOWNMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALUNKNOWNTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALUNKNOWNTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALUNKNOWNTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALVIDEO3SECVIEWS | Integer | ||
| TOTALVIDEOAVGWATCHTIMEINSECOND | String | ||
| TOTALVIDEOMRCVIEWS | Integer | ||
| TOTALVIDEOP0COMBINED | String | ||
| TOTALVIDEOP100COMPLETE | String | ||
| TOTALVIDEOP25COMBINED | String | ||
| TOTALVIDEOP50COMBINED | String | ||
| TOTALVIDEOP75COMBINED | String | ||
| TOTALVIDEOP95COMBINED | Integer | ||
| TOTALVIEWADDTOCART | Integer | ||
| TOTALVIEWADDTOCARTQUANTITY | Integer | ||
| TOTALVIEWADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWAPPINSTALL | Integer | ||
| TOTALVIEWAPPINSTALLVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWCATEGORYDESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALVIEWCATEGORYDESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALVIEWCATEGORYDESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALVIEWCATEGORYMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALVIEWCATEGORYMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALVIEWCATEGORYMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALVIEWCATEGORYTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALVIEWCATEGORYTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALVIEWCATEGORYTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALVIEWCHECKOUT | Integer | ||
| TOTALVIEWCHECKOUTQUANTITY | Integer | ||
| TOTALVIEWCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWCUSTOM | Integer | ||
| TOTALVIEWCUSTOMQUANTITY | Integer | ||
| TOTALVIEWCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWLEAD | Integer | ||
| TOTALVIEWLEADQUANTITY | Integer | ||
| TOTALVIEWLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWPAGEVISIT | Integer | ||
| TOTALVIEWPAGEVISITQUANTITY | Integer | ||
| TOTALVIEWPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWSEARCH | Integer | ||
| TOTALVIEWSEARCHQUANTITY | Integer | ||
| TOTALVIEWSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWSIGNUP | Integer | ||
| TOTALVIEWSIGNUPQUANTITY | Integer | ||
| TOTALVIEWSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWUNKNOWN | Integer | ||
| TOTALVIEWUNKNOWNQUANTITY | Integer | ||
| TOTALVIEWUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWVIEWCATEGORY | String | ||
| TOTALVIEWVIEWCATEGORYQUANTITY | Integer | ||
| TOTALVIEWVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALVIEWWATCHVIDEO | Integer | ||
| TOTALVIEWWATCHVIDEOQUANTITY | Integer | ||
| TOTALVIEWWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALWATCHVIDEODESKTOPACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALWATCHVIDEODESKTOPACTIONTOMOBILECONVERSION | Integer | ||
| TOTALWATCHVIDEODESKTOPACTIONTOTABLETCONVERSION | Integer | ||
| TOTALWATCHVIDEOMOBILEACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALWATCHVIDEOMOBILEACTIONTOMOBILECONVERSION | Integer | ||
| TOTALWATCHVIDEOMOBILEACTIONTOTABLETCONVERSION | Integer | ||
| TOTALWATCHVIDEOTABLETACTIONTODESKTOPCONVERSION | Integer | ||
| TOTALWATCHVIDEOTABLETACTIONTOMOBILECONVERSION | Integer | ||
| TOTALWATCHVIDEOTABLETACTIONTOTABLETCONVERSION | Integer | ||
| TOTALWEBADDTOCART | Integer | ||
| TOTALWEBADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCHECKOUT | Integer | ||
| TOTALWEBCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKADDTOCART | Integer | ||
| TOTALWEBCLICKADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKCHECKOUT | Integer | ||
| TOTALWEBCLICKCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKCUSTOM | Integer | ||
| TOTALWEBCLICKCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKLEAD | Integer | ||
| TOTALWEBCLICKLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKPAGEVISIT | Integer | ||
| TOTALWEBCLICKPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKSEARCH | Integer | ||
| TOTALWEBCLICKSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKSIGNUP | Integer | ||
| TOTALWEBCLICKSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKUNKNOWN | Integer | ||
| TOTALWEBCLICKUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKVIEWCATEGORY | String | ||
| TOTALWEBCLICKVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCLICKWATCHVIDEO | Integer | ||
| TOTALWEBCLICKWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBCUSTOM | Integer | ||
| TOTALWEBCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTADDTOCART | Integer | ||
| TOTALWEBENGAGEMENTADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTCHECKOUT | Integer | ||
| TOTALWEBENGAGEMENTCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTCUSTOM | Integer | ||
| TOTALWEBENGAGEMENTCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTLEAD | Integer | ||
| TOTALWEBENGAGEMENTLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTPAGEVISIT | Integer | ||
| TOTALWEBENGAGEMENTPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTSEARCH | Integer | ||
| TOTALWEBENGAGEMENTSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTSIGNUP | Integer | ||
| TOTALWEBENGAGEMENTSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTUNKNOWN | Integer | ||
| TOTALWEBENGAGEMENTUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTVIEWCATEGORY | String | ||
| TOTALWEBENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBENGAGEMENTWATCHVIDEO | Integer | ||
| TOTALWEBENGAGEMENTWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBLEAD | Integer | ||
| TOTALWEBLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBPAGEVISIT | Integer | ||
| TOTALWEBPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBSEARCH | Integer | ||
| TOTALWEBSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBSESSIONS | Integer | ||
| TOTALWEBSIGNUP | Integer | ||
| TOTALWEBSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBUNKNOWN | String | ||
| TOTALWEBUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWADDTOCART | Integer | ||
| TOTALWEBVIEWADDTOCARTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWCATEGORY | String | ||
| TOTALWEBVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWCHECKOUT | Integer | ||
| TOTALWEBVIEWCHECKOUTVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWCUSTOM | Integer | ||
| TOTALWEBVIEWCUSTOMVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWLEAD | Integer | ||
| TOTALWEBVIEWLEADVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWPAGEVISIT | Integer | ||
| TOTALWEBVIEWPAGEVISITVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWSEARCH | Integer | ||
| TOTALWEBVIEWSEARCHVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWSIGNUP | Integer | ||
| TOTALWEBVIEWSIGNUPVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWUNKNOWN | String | ||
| TOTALWEBVIEWUNKNOWNVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWVIEWCATEGORY | String | ||
| TOTALWEBVIEWVIEWCATEGORYVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBVIEWWATCHVIDEO | Integer | ||
| TOTALWEBVIEWWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| TOTALWEBWATCHVIDEO | Integer | ||
| TOTALWEBWATCHVIDEOVALUEINMICRODOLLAR | Integer | ||
| VIDEO3SECVIEWS1 | String | ||
| VIDEO3SECVIEWS2 | String | ||
| VIDEOAVGWATCHTIMEINSECOND1 | String | ||
| VIDEOAVGWATCHTIMEINSECOND2 | String | ||
| VIDEOLENGTH | String | ||
| VIDEOMRCVIEWS1 | String | ||
| VIDEOMRCVIEWS2 | String | ||
| VIDEOP0COMBINED1 | String | ||
| VIDEOP0COMBINED2 | String | ||
| VIDEOP100COMPLETE1 | String | ||
| VIDEOP100COMPLETE2 | String | ||
| VIDEOP25COMBINED1 | String | ||
| VIDEOP25COMBINED2 | String | ||
| VIDEOP50COMBINED1 | String | ||
| VIDEOP50COMBINED2 | String | ||
| VIDEOP75COMBINED1 | String | ||
| VIDEOP75COMBINED2 | String | ||
| VIDEOP95COMBINED1 | String | ||
| VIDEOP95COMBINED2 | String | ||
| WEBADDTOCARTCOSTPERACTION | Integer | ||
| WEBADDTOCARTROAS | String | ||
| WEBCHECKOUTCOSTPERACTION | String | ||
| WEBCHECKOUTROAS | String | ||
| WEBCUSTOMCOSTPERACTION | Integer | ||
| WEBCUSTOMROAS | String | ||
| WEBLEADCOSTPERACTION | Integer | ||
| WEBLEADROAS | String | ||
| WEBPAGEVISITCOSTPERACTION | Integer | ||
| WEBPAGEVISITROAS | String | ||
| WEBSEARCHCOSTPERACTION | Integer | ||
| WEBSEARCHROAS | String | ||
| WEBSESSIONS1 | String | ||
| WEBSESSIONS2 | String | ||
| WEBSIGNUPCOSTPERACTION | Integer | ||
| WEBSIGNUPROAS | String | ||
| WEBUNKNOWNCOSTPERACTION | Integer | ||
| WEBUNKNOWNROAS | String | ||
| WEBVIEWCATEGORYCOSTPERACTION | Integer | ||
| WEBVIEWCATEGORYROAS | String | ||
| WEBWATCHVIDEOCOSTPERACTION | Integer | ||
| WEBWATCHVIDEOROAS | String | ||
| COSTPEROUTBOUNDCLICKINDOLLAR1 | Decimal | Average cost per paid outbound click. | |
| OUTBOUNDCTR1 | Decimal | Paid outbound clicks divided by paid impressions. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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. | |
| AttributionTypes | String | List of types of attribution for the conversion report
The allowed values are INDIVIDUAL, HOUSEHOLD. | |
| CampaignIds | String | Id of the campaign. | |
| CampaignStatuses | String | List of status values for filtering
The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| CampaignObjectiveTypes | String | List of status values for filtering
The allowed values are AWARENESS, CONSIDERATION, VIDEO_VIEW, WEB_CONVERSION, CATALOG_SALES, WEB_SESSIONS, VIDEO_COMPLETION. | |
| AdGroupIds | String | Id of the ad group. | |
| AdGroupStatuses | String | List of values for filtering.
The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| AdIds | String | List of ad ids | |
| AdStatuses | String | List of values for filtering.
The allowed values are APPROVED, PAUSED, PENDING, REJECTED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| ProductGroupIds | String | List of product group ids. | |
| ProductGroupStatuses | String | List of values for filtering.
The allowed values are RUNNING, PAUSED, EXCLUDED, ARCHIVED. | |
| TargetingTypes | String | Targeting type
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, GEO, AGE_BUCKET, REGION, AGE_BUCKET_AND_GENDER. | |
| AdsAnalyticsMetricsFilter | String | List of metrics filters | |
| ProductItemIds | String | List of product item ids. |
Get a list of the ad_accounts that the User has access to.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| IncludeSharedAccounts | = |
| Id | = |
For example:
SELECT * FROM AdAccounts
| Name | Type | References | Description |
| Id [KEY] | String | Id of the Ad Account. | |
| Name | String | Name of the Ad Account. | |
| OwnerUsername | String | Owner Usernameof the Ad Account. | |
| Country | String | Country of the ad account. | |
| Currency | String | Currency of the ad account. | |
| OwnerId | String | Owner UserId of the ad account. | |
| CreatedTime | Datetime | Created Time of the ad account. | |
| UpdatedTime | Datetime | Updated Time of the ad account. | |
| Permissions | String | Permissions of the ad account. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| IncludeSharedAccounts | Boolean | Include shared ad accounts |
Get targeting analytics for an ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| TargetingTypes | = |
For example:
SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
| AdGroupId | String |
AdGroups.Id | The ID of the ad group associated with this row. |
| TargetingType | String | The type of targeting used for this analytics row.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, GEO, AGE_BUCKET, REGION, AGE_BUCKET_AND_GENDER. | |
| TargetingValues | String | The value corresponding to the targeting type for this analytics row. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | The ID of the advertiser. | |
| AdGroupEntityStatus | Double | The entity status of the ad group. | |
| AdId | Double | The ID of the ad. | |
| CampaignId | String |
Campaigns.Id | The ID of the campaign. |
| CampaignDailySpendCap | String | The daily spending cap for the campaign in microcurrency. | |
| CampaignEntityStatus | String | The entity status of the campaign. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign in microcurrency. | |
| Ctr | Double | The click-through rate for paid impressions. | |
| Ctr2 | Double | The click-through rate for organic impressions. | |
| CheckoutRoas | Double | The return on ad spend for checkout conversions. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| Clickthrough1Gross | Integer | The total number of paid clickthroughs, including repeat clicks. | |
| CpcInMicroDollar | Decimal | The cost per click in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per thousand impressions in microdollars. | |
| Ectr | Decimal | The effective click-through rate. | |
| EcpeInDollar | Decimal | The effective cost per engagement in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| EcpvInDollar | Decimal | The effective cost per video view in dollars. | |
| EcpcvInDollar | Decimal | The effective cost per completed video view in dollars. | |
| EcpcvP95InDollar | Decimal | The effective cost per video view completed at 95% in dollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per thousand impressions in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The total number of paid impressions, including repeat views. | |
| Impression2 | Integer | The number of organic impressions. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits from Idea Pin product tag clicks. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits from Idea Pin product tag clicks. | |
| InAppCheckoutCostPerAction | Double | The cost per in-app checkout conversion. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PinId | String |
Pins.Id | The ID of the Pin. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | The return on ad spend for page visit conversions. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins (saves). | |
| Repin2 | Integer | The number of organic repins (saves). | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | The total number of clickthroughs across paid and organic. | |
| TotalEngagementSignup | Integer | The total number of signups driven by engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkouts driven by engagement. | |
| TotalClickSignup | Integer | The total number of signups driven by clicks. | |
| TotalClickCheckout | Integer | The total number of checkouts driven by clicks. | |
| TotalViewSignup | Integer | The total number of signups driven by views. | |
| TotalViewCheckout | Integer | The total number of checkouts driven by views. | |
| TotalConversions | Integer | The total number of conversions across all attribution types. | |
| TotalEngagementSignupValueInMicroDollar | Decimal | The total value of signups driven by engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | The total value of checkouts driven by engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Decimal | The total value of signups driven by clicks, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | The total value of checkouts driven by clicks, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Decimal | The total value of signups driven by views, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | The total value of checkouts driven by views, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visits attributed to the ad. | |
| TotalSignup | Integer | The total number of signups attributed to the ad. | |
| TotalCheckout | Integer | The total number of checkouts attributed to the ad. | |
| TotalSignupValueInMicroDollar | Decimal | The total value of signups attributed to the ad, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Decimal | The total value of checkouts attributed to the ad, in microdollars. | |
| 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 | The total number of video views meeting the MRC viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average watch time per video view, in seconds. | |
| TotalRepinRate | Double | The overall rate at which users repin the ad. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions driven by clicks. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions driven by clicks, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions driven by engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions driven by engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions driven by views. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions driven by views, in microdollars. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoLength | Integer | The length of the video in seconds. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC viewability standard. | |
| VideoP0Combined2 | Integer | Video 0 percent Combined Views. | |
| VideoP100Complete2 | Integer | Video 100 percent Complete Views. | |
| VideoP25Combined2 | Integer | Video 25 percent Complete Views. | |
| VideoP50Combined2 | Integer | Video 50 percent Complete Views. | |
| VideoP75Combined2 | Integer | Video 75 percent Complete Views. | |
| VideoP95Combined2 | Integer | Video 95 percent Complete Views. | |
| WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
| WebCheckoutRoas | Double | The return on ad spend for web checkout conversions. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AttributionTypes | String | List of types of attribution for the conversion report.
The allowed values are INDIVIDUAL, HOUSEHOLD. | |
| 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. | |
| 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 | Integer | 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Get analytics for the ads in the specified AdAccountId
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| AdId | =, IN |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
For example:
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'
| Name | Type | References | Description |
| AdId | String |
Ads.Id | The unique identifier of the ad. |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| Date | Date | Current metrics date. Only returned when granularity is a time-based value. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| AdGroupEntityStatus | String | Status of the ad group. | |
| SpendInDollar | Double | Total spend in dollars. | |
| EcpcInDollar | Double | The effective cost per click (ECPC), in dollars. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ectr | Double | The effective click-through rate (ECTR). | |
| EcpeInDollar | Double | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| RepinRate | Double | The repin rate. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CpmInDollar | Double | The cost per mille (CPM), in dollars. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| EcpvInDollar | Double | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Double | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Double | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalImpressionFrequency | Double | The total impression frequency, measured as impressions divided by unique users reached. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Double | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Double | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Double | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Double | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| AdvertiserId | String | The unique identifier of the advertiser. | |
| AdGroupId | String |
AdGroups.Id | The unique identifier of the ad group. |
| CampaignDailySpendCap | Integer | The daily spending cap for the campaign, in microcurrency. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| CampaignName | String | The name of the campaign. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| CpcInMicroDollar | Decimal | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per mille (CPM), in microdollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| Impression2 | Integer | The number of organic impressions. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| PinId | String |
Pins.Id | The unique identifier of the pin. |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| SpendInMicroDollar | Decimal | The total spend, in microdollars. | |
| TotalClickAddToCart | Integer | The total number of add-to-cart conversions attributed to a click. | |
| TotalClickLead | Integer | The total number of lead conversions attributed to a click. | |
| TotalCustom | Integer | The total number of custom conversions. | |
| TotalEngagement | Integer | The total number of engagements across paid and organic. | |
| TotalEngagementLead | Integer | The total number of lead conversions attributed to engagement. | |
| TotalIdeaPinProductTagVisit | Integer | The total number of product page visits via an Idea Pin product tag. | |
| TotalImpressionUser | Integer | The total number of unique users who saw an impression. | |
| TotalLead | Integer | The total number of lead conversions. | |
| TotalOfflineCheckout | Integer | The total number of offline checkout conversions. | |
| TotalViewAddToCart | Integer | The total number of add-to-cart conversions attributed to a view. | |
| TotalViewLead | Integer | The total number of lead conversions attributed to a view. | |
| TotalWebSessions | Integer | The total number of web sessions attributed to the ad. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Get analytics for the specified campaigns in the specified AdAccountId
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| CampaignId | =, IN |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
| ReportingTimezone | = |
| EngagementWindowDays | = |
| AggregateReportRows | = |
For example:
SELECT * FROM AdCampaignAnalytics WHERE AdAccountId = '3457832451' AND CampaignId = '3457862457'
SELECT * FROM AdCampaignAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| Date | Date | Date the analytics row covers. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| AdGroupEntityStatus | String | Status of the ad group. | |
| SpendInDollar | Double | Total spend in dollars. | |
| EcpcInDollar | Double | The effective cost per click (ECPC), in dollars. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ectr | Double | The effective click-through rate (ECTR). | |
| EcpeInDollar | Double | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| RepinRate | Double | The repin rate. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CpmInDollar | Double | The cost per mille (CPM), in dollars. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| EcpvInDollar | Double | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Double | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Double | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalImpressionFrequency | Double | The total impression frequency, measured as impressions divided by unique users reached. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Double | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Double | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Double | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Double | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| AdId | String |
Ads.Id | The unique identifier of the ad. |
| CampaignBudgetOptimization | Boolean | Whether campaign budget optimization is enabled for the campaign. | |
| AdGroupBudgetInLocalCurrency | String | The budget allocated to the ad group in the local currency. | |
| AdGroupBudgetType | String | The type of budget applied to the ad group.
The allowed values are DAILY, LIFETIME, CBO_ADGROUP. The default value is CBO_ADGROUP. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action (saves, closeups, link clicks, and carousel card swipes).
The allowed values are 0, 1, 7, 14, 30, 60. The default value is 30. | |
| AggregateReportRows | Boolean | Determines whether report rows should be aggregated across all requested entities. This feature is currently in beta and is not available to all users.
The default value is false. |
Get analytics for the ad groups in the specified AdAccountId
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| AdGroupId | =, IN |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
For example:
SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'
SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdGroupId | String |
AdGroups.Id | The unique identifier of the ad group. |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| Date | Date | Date the analytics row covers. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| AdGroupEntityStatus | String | Status of the ad group. | |
| SpendInDollar | Double | Total spend in dollars. | |
| EcpcInDollar | Double | The effective cost per click (ECPC), in dollars. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ectr | Double | The effective click-through rate (ECTR). | |
| EcpeInDollar | Double | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| RepinRate | Double | The repin rate. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CpmInDollar | Double | The cost per mille (CPM), in dollars. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| EcpvInDollar | Double | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Double | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Double | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalImpressionFrequency | Double | The total impression frequency, measured as impressions divided by unique users reached. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Double | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Double | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Double | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Double | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Double | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Double | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Double | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| Impression2 | Integer | The number of organic impressions. | |
| TotalImpressionUser | Integer | The total number of unique users who saw an impression. | |
| CampaignDailySpendCap | Integer | The daily spending cap for the campaign, in microcurrency. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| CpcInMicroDollar | Double | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Double | The cost per mille (CPM), in microdollars. | |
| EcpcInMicroDollar | Double | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Double | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| SpendInMicroDollar | Double | The total spend, in microdollars. | |
| TotalClickAddToCart | Integer | The total number of add-to-cart conversions attributed to a click. | |
| TotalClickLead | Integer | The total number of lead conversions attributed to a click. | |
| TotalCustom | Integer | The total number of custom conversions. | |
| TotalEngagement | Integer | The total number of engagements across paid and organic. | |
| TotalEngagementLead | Integer | The total number of lead conversions attributed to engagement. | |
| TotalIdeaPinProductTagVisit | Integer | The total number of product page visits via an Idea Pin product tag. | |
| TotalLead | Integer | The total number of lead conversions. | |
| TotalOfflineCheckout | Integer | The total number of offline checkout conversions. | |
| TotalViewAddToCart | Integer | The total number of add-to-cart conversions attributed to a view. | |
| TotalViewLead | Integer | The total number of lead conversions attributed to a view. | |
| TotalWebSessions | Integer | The total number of web sessions attributed to the ad. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| AdId | String |
Ads.Id | The unique identifier of the ad. |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| CampaignBudgetOptimization | Boolean | Whether campaign budget optimization is enabled for the campaign. | |
| AdGroupBudgetInLocalCurrency | String | The budget allocated to the ad group in the local currency. | |
| AdGroupBudgetType | String | The type of budget applied to the ad group.
The allowed values are DAILY, LIFETIME, CBO_ADGROUP. The default value is CBO_ADGROUP. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Query records for one or more ad groups. Returns all active previews associated with the provided ad group IDs. Each ad group is processed independently; individual failures do not block other previews.
The Cloud 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 Cloud. AdAccountId and AdGroupId are required columns to access this table.
SELECT * FROM AdGroupPreview WHERE AdAccountId = '549755885175' AND AdGroupId = '2680060704746'
SELECT * FROM AdGroupPreview WHERE AdAccountId = '549755885175' AND AdGroupId IN ('2680060704746', '2680060704747')
| Name | Type | References | Description |
| AdAccountId [KEY] | String |
AdAccounts.Id | Unique identifier of an ad account. |
| AdGroupId [KEY] | String |
AdGroups.Id | Unique identifier of the ad group. |
| Uuid [KEY] | String | Unique identifier of the ad preview record. | |
| Url | String | Preview URL for the ad group. Expires after the time indicated in ExpiresAt. Can be used in an iframe. | |
| ExpiresAt | Datetime | Unix timestamp (seconds) when the preview URL expires. | |
| ClientId | String | Client ID associated with the ad preview. | |
| UserId | String | User ID associated with the ad preview. | |
| PinId | String |
Pins.Id | Pin ID associated with the ad preview. |
| PinPromotionId | String | Pin promotion ID associated with the ad preview. | |
| PromotedProductGroupId | String | Promoted product group ID associated with the ad preview. | |
| IsActive | Boolean | Indicates whether the ad preview is currently active. |
Get a list of the ad_accounts that the User has access to.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Id | =, IN |
| CampaignId | =, IN |
| Status | = |
| TranslateInterestsToNames | = |
For example:
SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'
SELECT * FROM AdGroups WHERE CampaignId IN ('626759512981', '626759512982')
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the ad group. | |
| AdAccountId | String |
AdAccounts.Id | The ID of the ad account associated with this ad group. |
| CampaignId | String |
Campaigns.Id | Campaign ID of the ad group. |
| FeedProfileId | String | Feed Profile ID associated to the adgroup. | |
| AutoTargetingEnabled | Boolean | Enable auto-targeting for ad group. | |
| BidInMicroCurrency | Integer | Bid price in micro currency. | |
| BillableEvent | String | Ad group billable event type.
The allowed values are CLICKTHROUGH, IMPRESSION, VIDEO_V_50_MRC. | |
| BudgetInMicroCurrency | Integer | Budget in micro currency. | |
| BudgetType | String | The type of budget applied to the ad group.
The allowed values are DAILY, LIFETIME, CBO_ADGROUP. | |
| ConversionLearningModeType | String | The oCPM (Optimized Cost Per Mile) learning mode status for the ad group.
The allowed values are NOT_ACTIVE, ACTIVE. | |
| CreatedTime | Datetime | Ad group creation time. | |
| EndTime | Datetime | Ad group end time. | |
| LifetimeFrequencyCap | Integer | Set a limit to the number of times a promoted pin from this campaign can be impressed by a pinner within the past rolling 30 days. | |
| Name | String | Ad group name. | |
| PacingDeliveryType | String | The pacing and delivery type for the ad group.
The allowed values are STANDARD, ACCELERATED. | |
| PlacementGroup | String | The placement group for the ad group.
The allowed values are ALL, SEARCH, BROWSE, OTHER. | |
| StartTime | Datetime | Ad group start time | |
| Status | String | Ad group/entity status.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| SummaryStatus | String | Ad group summary status.
The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| TargetingSpec | String | Ad group targeting specification defining the ad group target audience. | |
| TrackingUrlsAudienceVerification | String | The third-party audience verification tracking URL for the ad group. | |
| TrackingUrlsBuyableButton | String | The third-party buyable button tracking URL for the ad group. | |
| TrackingUrlsClick | String | The third-party click tracking URL for the ad group. | |
| TrackingUrlsEngagement | String | The third-party engagement tracking URL for the ad group. | |
| TrackingUrlsImpression | String | The third-party impression tracking URL for the ad group. | |
| Type | String | Type of ad group. | |
| UpdatedTime | Datetime | Ad group last update time. | |
| IsCreativeOptimization | Boolean | Enable creative optimization for the ad group, default value is FALSE. When enabled, you allow Pinterest to automatically turn your product Pins into ads in different formats (collections and shopping) and deliver those ads to users at scale. | |
| PromotionId | String | Default:0, Promotion ID. To clear this field, set to null. | |
| PromotionApplicationLevel | String | Level at which promotions are applied to the ad group.
The allowed values are NONE, ITEM, AD_GROUP. | |
| PromotionIds | String | List of promotion IDs associated with the ad group. | |
| BidStrategyType | String | The bidding strategy applied to the ad group.
The allowed values are AUTOMATIC_BID, MAX_BID, TARGET_AVG. | |
| TargetingTemplateIds | String | The list of targeting template IDs applied to this ad group. | |
| DCAAssets | String | The Dynamic creative assets to use for DCA. Dynamic Creative Assembly (DCA) accepts basic creative assets of an ad (image, video, title, call to action, logo etc). | |
| OptimizationGoalMetadataConversionTagv3AttributionWindowsClickWindowDays | Integer | The number of days in the click attribution window used to track conversions for the v3 conversion tag optimization goal. | |
| OptimizationGoalMetadataConversionTagv3AttributionWindowsEngagementWindowDays | Integer | The number of days in the engagement attribution window used to track conversions for the v3 conversion tag optimization goal. | |
| OptimizationGoalMetadataConversionTagv3AttributionWindowsViewWindowDays | Integer | The number of days in the view attribution window used to track conversions for the v3 conversion tag optimization goal. | |
| OptimizationGoalMetadataConversionTagv3ConversionEvent | String | The Pinterest tag conversion event tracked by the v3 conversion tag optimization goal.
The allowed values are PAGE_VISIT, SIGNUP, CHECKOUT, CUSTOM, VIEW_CATEGORY, SEARCH, ADD_TO_CART, WATCH_VIDEO, LEAD, APP_INSTALL. | |
| OptimizationGoalMetadataConversionTagv3ConversionTagId | String | The ID of the Pinterest tag used for the v3 conversion tag optimization goal. | |
| OptimizationGoalMetadataConversionTagv3CPAGoalValueInMicroCurrency | String | The target cost-per-action (CPA) goal value in microcurrency for the v3 conversion tag optimization goal. | |
| OptimizationGoalMetadataConversionTagv3IsROASOptimized | Boolean | Pinterest Performance+ ROAS bidding. When enabled, Pinterest will optimize for conversion value instead of conversion volume. | |
| OptimizationGoalMetadataConversionTagv3ReportingEvent | String | Event name for custom or standard events mapped to an oCPM model. | |
| OptimizationGoalMetadataFrequencyGoalFrequency | Integer | The target number of impressions per user for the frequency cap optimization goal. | |
| OptimizationGoalMetadataFrequencyGoalTimerange | String | The timerange over which the frequency cap optimization goal is enforced.
The allowed values are THIRTY_DAY, DAY, SEVEN_DAY, TWENTY_MINUTE, TEN_MINUTE, TWENTY_FOUR_HOUR. | |
| OptimizationGoalMetadataScrollupGoalValueInMicroCurrency | String | The target scroll-up goal value in microcurrency for the scrollup optimization goal. | |
| BidMultiplier | Double | Bid multiplier for the ad group. This value is a double between 0.1 and 10.0. Enter 0 to remove the bid multiplier. Not currently supported for Performance+ campaigns. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| TranslateInterestsToNames | Boolean | Return interests as text names and not topic IDs. |
Get targeting analytics for one or more ad groups.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| AdGroupId | =, IN |
| TargetingType | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ConversionReportTime | = |
For example:
SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'
SELECT * FROM AdGroupTargetingAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| AdGroupId | String |
AdGroups.Id | The unique identifier of the ad group. |
| TargetingType | String | The type of targeting applied to the ad.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION, CREATIVE_ENHANCEMENTS. | |
| TargetingValues | String | The value of the targeting criterion for the specified targeting type. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | The unique identifier of the advertiser. | |
| AdGroupEntityStatus | Double | The status of the ad group. | |
| AdId | Double | The unique identifier of the ad. | |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| CampaignDailySpendCap | String | The daily spending cap for the campaign, in microcurrency. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| CpcInMicroDollar | Decimal | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per mille (CPM), in microdollars. | |
| Ectr | Decimal | The effective click-through rate (ECTR). | |
| EcpeInDollar | Decimal | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| EcpvInDollar | Decimal | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Decimal | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Decimal | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| Impression2 | Integer | The number of organic impressions. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PinId | String |
Pins.Id | The unique identifier of the pin. |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Decimal | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AttributionTypes | String | List of types of attribution for the conversion report.
The allowed values are INDIVIDUAL, HOUSEHOLD. | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 30, 60. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 30, 60. | |
| ConversionReportTime | Integer | 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Get a list of the ad_accounts that the User has access to.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Id | =, IN |
| AdGroupId | =, IN |
| CampaignId | =, IN |
| Status | = |
For example:
SELECT * FROM Ads WHERE AdAccountId = '3457832451'
| Name | Type | References | Description |
| Id [KEY] | String | The ID of this ad. | |
| AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
| AdGroupId | String |
AdGroups.Id | ID of the ad group that contains the ad. |
| AndroidDeepLink | String | Deep link URL for Android devices. Not currently available. Using this field will generate an error. | |
| CampaignId | String |
Campaigns.Id | ID of the ad campaign that contains this ad. |
| CarouselAndroidDeepLinks | String | Comma-separated deep links for the carousel pin on Android. | |
| CarouselDestinationUrls | String | Comma-separated destination URLs for the carousel pin to promote. | |
| CarouselIosDeepLinks | String | Comma-separated deep links for the carousel pin on iOS. | |
| ClickTrackingUrl | String | Tracking URL for the ad clicks. | |
| CollectionItemsDestinationUrlTemplate | String | Destination URL template for all items within a collections drawer. | |
| CreatedTime | Datetime | Pin creation time. | |
| CreativeType | String | The creative type of the ad.
The allowed values are REGULAR, VIDEO, SHOPPING, CAROUSEL, MAX_VIDEO, SHOP_THE_PIN, COLLECTION, IDEA, SHOWCASE, QUIZ, COLLAGE, MAX_WIDTH_REGULAR_COLLECTION, MAX_WIDTH_VIDEO_COLLECTION. | |
| DestinationUrl | String | The destination URL where users are directed after clicking the ad. | |
| DisclosureType | String | Type of disclosure displayed with the ad.
The allowed values are IMPORTANT_SAFETY_INFO, MED_GUIDE, PATIENT_INFORMATION, NO_DISCLOSURE, PRESCRIBING_INFORMATION, PRESCRIBING_INFORMATION_BOX_WARNING. | |
| DisclosureUrl | String | URL of the disclosure document associated with the ad. | |
| IosDeepLink | String | Deep link URL for iOS devices. | |
| IsPinDeleted | Boolean | Indicates whether the original pin has been deleted. | |
| IsRemovable | Boolean | Indicates whether the pin can be repinned by other users. | |
| Name | String | Name of the ad. | |
| PinId | String | The ID of the pin associated with this ad. | |
| RejectedReasons | String | Reason why the pin was rejected. | |
| RejectionLabels | String | Text reason why the pin was rejected. | |
| ReviewStatus | String | The current review status of the ad.
The allowed values are OTHER, PENDING, REJECTED, APPROVED. | |
| Status | String | The current status of the ad.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| SummaryStatus | String | Ad summary status.
The allowed values are APPROVED, PAUSED, PENDING, REJECTED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| TrackingUrlsAudienceVerification | String | The third-party audience verification tracking URL for the ad. | |
| TrackingUrlsBuyableButton | String | The third-party buyable button tracking URL for the ad. | |
| TrackingUrlsClick | String | The third-party click tracking URL for the ad. | |
| TrackingUrlsEngagement | String | The third-party engagement tracking URL for the ad. | |
| TrackingUrlsImpression | String | The third-party impression tracking URL for the ad. | |
| Type | String | The type of the ad. | |
| UpdatedTime | Datetime | Last update time. | |
| ViewTrackingUrl | String | Tracking URL for ad impressions. | |
| LeadFormId | String | The ID of the lead form linked to this lead generation ad. | |
| GridClickType | String | Specifies the destination when a user clicks on an ad in the grid view.
The allowed values are CLOSEUP, DIRECT_TO_DESTINATION. | |
| CustomizableCTAType | String | The type of call-to-action (CTA) displayed below the ad. | |
| QuizPinDataQuestions | String | The list of questions presented to users in the quiz pin. | |
| QuizPinDataResults | String | The possible results shown to users based on their quiz answers, including outbound links. | |
| QuizPinDataTieBreakerType | String | The method used to resolve ties in quiz results, with a default of RANDOM.
The allowed values are RANDOM, CUSTOM. | |
| QuizPinDataTieBreakerCustomResultAndroidDeepLink | String | The Android deep link URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultDestinationURL | String | The destination URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultIosDeepLink | String | The iOS deep link URL for the custom tie-breaker result of the quiz pin. | |
| QuizPinDataTieBreakerCustomResultOrganicPinId | String | The organic pin ID used as the custom tie-breaker result for the quiz pin. | |
| QuizPinDataTieBreakerCustomResultId | Integer | The unique identifier of the custom tie-breaker result for the quiz pin. | |
| IsCollageSingleDestination | Boolean | Whether the collage ad has a single destination URL override. | |
| IsCollageAcceptedTerms | Boolean | Whether the advertiser has accepted the terms and conditions for the collage ad. |
Returns the list of ads credit discounts applied to the specified ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM AdsCreditDiscounts WHERE AdAccountId = '549768561505'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account associated with these discounts. |
| Active | Boolean | True if the offer code is currently active. | |
| AdvertiserId | String | Advertiser ID the offer was applied to. | |
| DiscountCurrency | String | Currency value for the discount. | |
| DiscountInMicroCurrency | Double | The discount applied in the offer's currency value. | |
| DiscountType | String | The type of discount of this credit.
The allowed values are COUPON, CREDIT, COUPON_APPLIED, CREDIT_APPLIED, MARKETING_OFFER_CREDIT, MARKETING_OFFER_CREDIT_APPLIED, GOODWILL_CREDIT, GOODWILL_CREDIT_APPLIED, INTERNAL_CREDIT, INTERNAL_CREDIT_APPLIED, PREPAID_CREDIT, PREPAID_CREDIT_APPLIED, SALES_INCENTIVE_CREDIT, SALES_INCENTIVE_CREDIT_APPLIED, CREDIT_EXPIRED, FUTURE_CREDIT, REFERRAL_CREDIT, INVOICE_SALES_INCENTIVE_CREDIT, INVOICE_SALES_INCENTIVE_CREDIT_APPLIED, PREPAID_CREDIT_REFUND. | |
| RemainingDiscountInMicroCurrency | Double | The credits left to spend. | |
| Title | String | Human readable title of the offer code. |
Get targeting analytics for one or more ads.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| TargetingTypes | = |
| AdId | = |
For example:
SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| AdId | String |
Ads.Id | The unique identifier of the ad. |
| TargetingType | String | The type of targeting applied to the ad.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION. | |
| TargetingValues | String | The value of the targeting criterion for the specified targeting type. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | The unique identifier of the advertiser. | |
| AdGroupEntityStatus | Double | The status of the ad group. | |
| MetricsAdId | String |
Ads.Id | The unique identifier of the ad. |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| CampaignDailySpendCap | String | The daily spending cap for the campaign, in microcurrency. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| CpcInMicroDollar | Decimal | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per mille (CPM), in microdollars. | |
| Ectr | Decimal | The effective click-through rate (ECTR). | |
| EcpeInDollar | Decimal | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| EcpvInDollar | Decimal | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Decimal | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Decimal | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| Impression2 | Integer | The number of organic impressions. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PinId | String |
Pins.Id | The unique identifier of the pin. |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Decimal | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AttributionTypes | String | List of types of attribution for the conversion report.
The allowed values are INDIVIDUAL, HOUSEHOLD. | |
| 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. | |
| 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 | Integer | 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Get advertiser defined events for the given ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM AdvertiserDefinedEvents WHERE AdAccountId = '549768561505'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account associated with these events. |
| Name | String | Raw string name of the event, usually logged as raw_event_name in the dataset. | |
| MappedConversionType | String | Standard Pinterest conversion type mapped to this advertiser defined event for optimization.
The allowed values are PAGE_LOAD, UNKNOWN, INITIALIZED, PAGE_VISIT, SIGNUP, CHECKOUT, CUSTOM, VIEW_CATEGORY, SEARCH, ADD_TO_CART, WATCH_VIDEO, LEAD, APP_INSTALL, WEB_SESSION, EXTERNAL_MEASUREMENT, ADD_PAYMENT_INFO, ADD_TO_WISHLIST, INITIATE_CHECKOUT, SUBSCRIBE, VIEW_CONTENT, ADVERTISER_DEFINED_EVENT, APP_OPEN, CONTACT, SCHEDULE, FIND_LOCATION, CUSTOMIZE_PRODUCT, SUBMIT_APPLICATION, START_TRIAL. |
Get Audience Insights for an ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountID | = |
| Type | = |
For example:
SELECT * FROM AudienceInsights
SELECT * FROM AudienceInsights WHERE AdAccountId = '54736262148'
SELECT * FROM AudienceInsights WHERE Type = 'PINTEREST_TOTAL_AUDIENCE'
| Name | Type | References | Description |
| Type | String | Type of audience insights. | |
| Date | Datetime | Generation date. | |
| Size | Integer | Population count. | |
| SizeIsUpperBound | Boolean | Indicates whether the audience size has been rounded up to the next highest upper boundary. | |
| Categories | String | Categories. | |
| Demographics | String | Audience demographics. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountID | String | Unique identifier of an ad account. |
Get the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction on pins.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountID | = |
For example:
SELECT * FROM AudienceInsightsScopeAndType
SELECT * FROM AudienceInsightsScopeAndType WHERE AdAccountId = '547362621403'
| Name | Type | References | Description |
| Date | Datetime | Generation date. | |
| Type | String | Type. | |
| Scope | String | Scope. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountID | String | Unique identifier of an ad account. |
Returns a list of audiences for the ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| AdAccountId | = |
For example:
SELECT * FROM Audiences WHERE Id = '2542622901002'
SELECT * FROM Audiences WHERE AdAccountId = '549768233165'
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the audience. | |
| AdAccountId | String |
AdAccounts.Id | The ID of the ad account associated with this audience. |
| Name | String | The name of the audience. | |
| AudienceType | String | The type of the audience.
The allowed values are ACTALIKE, ENGAGEMENT, CUSTOMER_LIST, VISITOR. | |
| Description | String | The description of the audience. | |
| RuleCountry | String | The country for the audience rule.
The allowed values are US, CA, GB. | |
| RuleCustomerListId | String | The Id of the customer list. Applicable for the CUSTOMER_LIST audience type. | |
| RuleEngagementDomain | String | The domain used for engagement targeting. | |
| RuleEngagementType | String | The type of engagement. Optional for the ENGAGEMENT audience type.
The allowed values are click, save, closeup, comment, like. | |
| RuleEvent | String | A Pinterest tag event. Optional for the VISITOR audience type.
The allowed values are pagevisit, signup, checkout, viewcategory, search, addtocart, watchvideo, lead, custom. | |
| RuleEventDataCurrency | String | The currency code, per ISO 4217. | |
| RuleEventDataLeadType | String | The lead type associated with the event data. | |
| RuleEventDataLineItemsProductBrand | String | The brand of the product. | |
| RuleEventDataLineItemsProductCategory | String | The category of the product. | |
| RuleEventDataLineItemsProductId | Integer | The Id of the product. | |
| RuleEventDataLineItemsProductName | String | The name of the product. | |
| RuleEventDataLineItemsProductPrice | String | The price of the product. | |
| RuleEventDataLineItemsProductQuantity | Integer | The quantity of the product. | |
| RuleEventDataLineItemsProductVariant | String | The variant of the product. | |
| RuleEventDataLineItemsProductVariantId | String | The Id of the product variant. | |
| RuleEventDataOrderId | String | The Id of the order. | |
| RuleEventDataOrderQuantity | Integer | The quantity of the order. | |
| RuleEventDataPageName | String | The name of the page. | |
| RuleEventDataPromoCode | String | The promotion code associated with the event. | |
| RuleEventDataProperty | String | The property associated with the event data. | |
| RuleEventDataSearchQuery | String | The search query string associated with the event. | |
| RuleEventDataValue | String | The monetary value of the product. | |
| RuleEventDataVideoTitle | String | The title of the video. | |
| RulePercentage | Integer | The percentage size of the targeted audience across Pinterest. Accepted values are 1 to 10. | |
| RulePinId | String | The Id of the pin. | |
| RulePrefill | Boolean | Indicates whether the audience rule is prefilled. Optional for the VISITOR audience type. The default is true. | |
| RuleRetentionDays | Integer | The number of days a Pinterest user remains in the audience. Optional for the ENGAGEMENT and VISITOR audience types. | |
| RuleSeedId | String | The Id of the seed audience. | |
| RuleUrl | String | The URL for the visitor audience rule. | |
| RuleVisitorSourceId | String | The Id of the conversion tag or Pinterest tag used on the website. Applicable for the VISITOR audience type. | |
| RuleEventSource | String | The event source for the visitor audience rule. Optional for the VISITOR audience type. | |
| RuleIngestionSource | String | The ingestion source for the visitor audience rule. Optional for the VISITOR audience type. Supported values are: tag, mmp, file_upload, conversions_api. | |
| RuleEngagerType | Integer | The engager type. Accepted values are 1 to 2. Optional for the ENGAGEMENT audience type. | |
| RuleCampaignId | String | The Id of the campaign. | |
| RuleAdId | String | The Id of the ad. | |
| RuleObjectiveType | String | The objective type of the ad. | |
| RuleAdAccountId | String | The Id of the ad account for the audience rule. | |
| Size | Integer | The size of the audience. | |
| Status | String | The status of the audience.
The allowed values are READY, INITIALIZING, TOO_SMALL, ELIGIBLE, PERSONAS_INELIGIBLE_SIZE, PERSONAS_INITIALIZING. | |
| Type | String | Always 'audience'. | |
| CreatedTime | Datetime | The creation time as a Unix timestamp in seconds. | |
| UpdatedTime | Datetime | The last update time as a Unix timestamp in seconds. | |
| CreatedByCompanyName | String | The company that created this audience. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| OwnershipType | String | The ownership type of the audience, indicating whether it is owned by this account or received from another account.
The allowed values are OWNED, RECEIVED. |
Get billing invoices in the advertiser account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Status | = |
| DocumentType | = |
| StartDueDate | = |
| EndDueDate | = |
For example:
SELECT * FROM BillingInvoices WHERE AdAccountId = '549768561505'
SELECT * FROM BillingInvoices WHERE AdAccountId = '549768561505' AND Status = 'OPEN' AND StartDueDate = '2024-01-01' AND EndDueDate = '2024-12-31'
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier for the billing invoice. | |
| AdAccountId | String |
AdAccounts.Id | The ID of the ad account this invoice belongs to. |
| AdAccountName | String | The name of the ad account this invoice belongs to. | |
| AmountBilledMicroCurrency | Long | The amount billed in this invoice, denoted in micro currency. | |
| AmountDiscountMicroCurrency | Long | The discount in this invoice, denoted in micro currency. | |
| AmountNetMicroCurrency | Long | The net amount in this invoice, denoted in micro currency. | |
| AmountTaxMicroCurrency | Long | The tax in this invoice, denoted in micro currency. | |
| BillToCountry | String | The country of the bill-to address. | |
| BillingPeriodStartDate | Date | The start date of the billing period. Format: YYYY-MM-DD. | |
| BillingPeriodEndDate | Date | The end date of the billing period. Format: YYYY-MM-DD. | |
| Currency | String | Currency code from ISO 4217.
The allowed values are UNK, USD. | |
| DocumentType | String | The type of the document.
The allowed values are INVOICE, CREDIT_MEMO. | |
| InvoiceDueDate | Date | The date the invoice is due. Format: YYYY-MM-DD. | |
| PaymentTerms | String | The payment terms of the invoice. | |
| Status | String | The status of the invoice.
The allowed values are OPEN, CLOSED. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| StartDueDate | Date | Starting point for due dates when searching for invoices. Format: YYYY-MM-DD. | |
| EndDueDate | Date | Ending point for due dates when searching for invoices. Format: YYYY-MM-DD. |
Get billing profiles in the advertiser account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
IsActive is a required column to query this view.
| Column | Supported Operators |
| AdAccountId | = |
| IsActive | = |
For example:
SELECT * FROM BillingProfiles WHERE AdAccountId = '549768561505' AND IsActive = false
| Name | Type | References | Description |
| Id [KEY] | String | Billing ID. | |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account associated with these billing profiles. |
| AdvertiserId | String | Advertiser ID of the billing. | |
| BillingType | String | Billing type of the advertiser.
The allowed values are CREDIT_CARD, INVOICE, INTERNAL, RECURRING, PREPAID. | |
| CardType | String | Type of the credit card.
The allowed values are UNKNOWN, VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, ELO. | |
| PaymentMethodBrand | String | Brand of the payment method.
The allowed values are UNKNOWN, VISA, MASTERCARD, AMERICAN_EXPRESS, DISCOVER, SOFORT, DINERS_CLUB, ELO, CARTE_BANCAIRE. | |
| Status | String | Status of the billing.
The allowed values are UNSPECIFIED, VALID, INVALID, PENDING, DELETED, SECONDARY, PENDING_SECONDARY. | |
| IsActive | Boolean | Return active billing profiles when true; return all billing profiles when false. |
Get a list of the boards owned by the User
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| Privacy | = |
| AdAccountId | = |
For example:
SELECT * FROM Boards WHERE Id = '345787634451'
SELECT * FROM Boards WHERE AdAccountId = '549769357724'
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the board. | |
| Name | String | The name of the board. | |
| Description | String | The description of the board. | |
| OwnerUsername | String | UserName of the Owner. | |
| Privacy | String | Privacy setting for the board.
The allowed values are PUBLIC, PROTECTED, SECRET. | |
| MediaImageCoverUrl | String | Media image cover url for the board. | |
| MediaPinThumbnailUrls | String | Pin thumbnail urls for the board. | |
| PinCount | Integer | The number of pins on the board. | |
| FollowerCount | Integer | The number of users following the board. | |
| CollaboratorCount | Integer | The number of collaborators on the board. | |
| CreatedAt | Datetime | The date and time when the board was created. | |
| BoardPinsModifiedAt | Datetime | The date and time when the board's pins were last modified. | |
| IsAdsOnly | Boolean | Indicates whether the board is restricted to ad-only content. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. When specified, boards are returned for the owner of this ad account. Filter only. |
Get a list of the boards owned by the User
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| BoardId | = |
For example:
SELECT * FROM BoardSections WHERE BoardId = '345787634451'
| Name | Type | References | Description |
| Id [KEY] | String | Id of the Section. | |
| Name | String | Name of the Section. | |
| BoardId | String |
Boards.Id | Id of the Board. |
Get all the assets the requesting business has access to, including assets the business owns and assets accessed through partnerships.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
BusinessId is a required column to query this view.
| Column | Supported Operators |
| BusinessId | = |
| AssetType | = |
| Permissions | = |
| ChildAssetId | = |
| AssetGroupId | = |
For example:
SELECT * FROM BusinessAssets WHERE BusinessId = '549768561505'
SELECT * FROM BusinessAssets WHERE BusinessId = '549768561505' AND AssetType = 'CATALOG'
| Name | Type | References | Description |
| BusinessId | String | The unique identifier of the requesting business. | |
| AssetId [KEY] | String | Unique identifier of a business asset. | |
| AssetType | String | Type of the asset. Filtering defaults to AD_ACCOUNT server-side when omitted.
The allowed values are AD_ACCOUNT, MERCHANT, PROFILE, ASSET_GROUP, PINNER_LIST, CONVERSION_TAG, CATALOG, CONVERSION_SEGMENT. | |
| Permissions | String | Permission levels the requesting business has on the asset.
The allowed values are ADMIN, ANALYST, FINANCE_MANAGER, FINANCE_EDIT, FINANCE_VIEW, AUDIENCE_MANAGER, CAMPAIGN_MANAGER, CATALOGS_MANAGER, CATALOGS_VIEWER, PROFILE_PUBLISHER, OWNER. | |
| CatalogType | String | The catalog type. Populated only when AssetType is CATALOG. | |
| CatalogId | String | The catalog ID. Populated only when AssetType is CATALOG. | |
| CatalogName | String | The catalog name. Populated only when AssetType is CATALOG. | |
| AdAccountInfoTargetingRmnBusinessId | String | RMN business ID for the ad account. Populated only when AssetType is AD_ACCOUNT. | |
| AssetGroupInfoId | String | The asset group ID. Populated only when AssetType is ASSET_GROUP. | |
| AssetGroupName | String | The name of the asset group. | |
| AssetGroupDescription | String | The description of the asset group. | |
| AssetGroupTypes | String | A list of asset group types. | |
| AssetGroupInfoAdAccountsIds | String | A list of ad account IDs under the asset group. | |
| AssetGroupCatalogsIds | String | A list of catalog IDs under the asset group. | |
| AssetGroupProfilesIds | String | A list of profile IDs under the asset group. | |
| AssetGroupCreatedTime | Datetime | The time the asset group was created. | |
| AssetGroupUpdatedTime | Datetime | The time the asset group was last updated. | |
| AssetGroupCreatedByEmail | String | The email of the user who created the asset group. | |
| AssetGroupCreatedById | String | The ID of the user who created the asset group. | |
| AssetGroupCreatedByUsername | String | The username of the user who created the asset group. | |
| AssetGroupOwnerEmail | String | The email of the asset group owner. | |
| AssetGroupOwnerId | String | The ID of the asset group owner. | |
| AssetGroupOwnerUsername | String | The username of the asset group owner. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| ChildAssetId | String | A child asset unique identifier. Used to fetch asset groups that contain the asset id as a child. | |
| AssetGroupId | String | An asset group unique identifier. Used to fetch assets contained within the specified asset group. |
Get account information for the operation user_account
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Id | =, IN |
| Status | = |
For example:
SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the campaign. | |
| AdAccountId | String |
AdAccounts.Id | The ID of the ad account associated with this campaign. |
| CreatedTime | Datetime | Campaign creation time. | |
| DailySpendCap | Integer | The daily spending cap for the campaign in microcurrency. | |
| LifetimeSpendCap | Integer | The lifetime spending cap for the campaign in microcurrency. | |
| Name | String | The name of the campaign. | |
| ObjectiveType | String | Campaign objective type. Deprecated values are WEB_SESSIONS and VIDEO_VIEW (use VIDEO_COMPLETION instead).
The allowed values are AWARENESS, CONSIDERATION, WEB_CONVERSION, CATALOG_SALES, VIDEO_COMPLETION, APP_INSTALL, SALES, LEADS, WEB_SESSIONS, VIDEO_VIEW. | |
| OrderLineId | String | Order line ID that appears on the invoice. | |
| Status | String | The current status of the campaign.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| TrackingUrlsAudienceVerification | String | The third-party audience verification tracking URL for the campaign. | |
| TrackingUrlsBuyableButton | String | The third-party buyable button tracking URL for the campaign. | |
| TrackingUrlsClick | String | The third-party click tracking URL for the campaign. | |
| TrackingUrlsEngagement | String | The third-party engagement tracking URL for the campaign. | |
| TrackingUrlsImpression | String | The third-party impression tracking URL for the campaign. | |
| Type | String | The type of the campaign. | |
| UpdatedTime | Datetime | The date and time when the campaign was last updated. | |
| StartTime | Datetime | The scheduled start time for the campaign. | |
| EndTime | Datetime | The scheduled end time for the campaign. | |
| SummaryStatus | String | The computed delivery status of the campaign, which may differ from the entity status.
The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| IsFlexibleDailyBudgets | Boolean | Indicates whether flexible daily budgets are enabled for the campaign. | |
| IsCampaignBudgetOptimization | Boolean | Indicates whether campaign budget optimization is enabled for the campaign. | |
| IsAutomatedCampaign | Boolean | Specifies whether the campaign was created in the automated campaign flow. | |
| IsPerformancePlus | Boolean | Indicates whether Pinterest Performance+ is enabled for the campaign. | |
| BidOptionsAgeBucketMultipliersAgeBucket | String | The age range identifier to which the bid multiplier is applied.
The allowed values are 18-24, 19+, 20+, 21+, 25-34, 35-44, 45-49, 50-54, 55-64, 65+. | |
| BidOptionsAgeBucketMultipliersProperty1 | Double | Bid multiplier value for age bucket targeting. | |
| BidOptionsAgeBucketMultipliersProperty2 | Double | Bid multiplier value for age bucket targeting. | |
| BidOptionsAppTypeMultipliersAppType | String | The app type identifier to which the bid multiplier is applied.
The allowed values are android_mobile, android_tablet, ipad, iphone, web, web_mobile. | |
| BidOptionsAppTypeMultipliersProperty1 | Double | The first bid multiplier value applied to the specified app type. | |
| BidOptionsAppTypeMultipliersProperty2 | Double | The second bid multiplier value applied to the specified app type. | |
| BidOptionsAudienceMultipliersAudienceId | String | The ID of the audience to which the bid multiplier is applied. | |
| BidOptionsAudienceMultipliersProperty1 | Double | Bid multiplier value for audience targeting. Must be between 0 and 10. | |
| BidOptionsAudienceMultipliersProperty2 | Double | Bid multiplier value for audience targeting. Must be between 0 and 10. | |
| BidOptionsGenderMultipliersGender | String | The gender identifier to which the bid multiplier is applied.
The allowed values are unknown, male, female. | |
| BidOptionsGenderMultipliersProperty1 | Double | Bid multiplier value for gender targeting. | |
| BidOptionsGenderMultipliersProperty2 | Double | Bid multiplier value for gender targeting. | |
| BidOptionsPlacementMultipliersPlacement | String | Placement type for bid multiplier targeting.
The allowed values are SEARCH, BROWSE, RELATED_PINS. | |
| BidOptionsPlacementMultipliersProperty1 | Double | The first bid multiplier value applied to the specified placement type. | |
| BidOptionsPlacementMultipliersProperty2 | Double | The second bid multiplier value applied to the specified placement type. | |
| BidOptionsFrequencyMultipliersImpressionCount | String | The impression count identifier to which the frequency bid multiplier is applied. | |
| BidOptionsFrequencyMultipliersProperty1 | Double | The first bid multiplier value applied to the specified impression count bucket. | |
| BidOptionsFrequencyMultipliersProperty2 | Double | The second bid multiplier value applied to the specified impression count bucket. | |
| BidOptionsFreqBidMultiplierTimeWindow | String | The time window for frequency bid multipliers.
The allowed values are WEEK, MONTH. | |
| DefaultAdGroupBudgetInMicroCurrency | Integer | When transitioning from campaign budget optimization to non-campaign budget optimization, this value propagates to each child ad group's daily budget. Unit is micro currency of the associated advertiser account. |
Get targeting analytics for one or more campaign.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| TargetingTypes | = |
| CampaignId | = |
For example:
SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM CampaignTargetingAnalytics WHERE CampaignId = '451'
SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| TargetingType | String | The type of targeting applied to the ad.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, GEO, AGE_BUCKET, REGION, CREATIVE_TYPE, AGE_BUCKET_AND_GENDER. | |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| TargetingValues | String | The value of the targeting criterion for the specified targeting type. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | The unique identifier of the advertiser. | |
| AdGroupEntityStatus | Double | The status of the ad group. | |
| AdId | Double | The unique identifier of the ad. | |
| MetricCampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| CampaignDailySpendCap | String | The daily spending cap for the campaign, in microcurrency. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| CpcInMicroDollar | Decimal | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per mille (CPM), in microdollars. | |
| Ectr | Decimal | The effective click-through rate (ECTR). | |
| EcpeInDollar | Decimal | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| EcpvInDollar | Decimal | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Decimal | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Decimal | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| Impression2 | Integer | The number of organic impressions. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PinId | String |
Pins.Id | The unique identifier of the pin. |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Decimal | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AttributionTypes | String | List of types of attribution for the conversion report.
The allowed values are INDIVIDUAL, HOUSEHOLD. | |
| 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. | |
| 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 | Integer | 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Returns the hotel catalog processing report with status, run timestamps, item counts, and error summaries.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| CatalogId | = |
| CatalogType | = |
| ReportType | = |
| FeedId | = |
| ProcessingResultId | = |
| AdAccountId | = |
For example:
SELECT * FROM CatalogHotelReport
SELECT * FROM CatalogHotelReport WHERE CatalogId='4853306950123'
SELECT * FROM CatalogHotelReport WHERE AdAccountId = '549768233165'
SELECT * FROM CatalogHotelReport WHERE CatalogType = 'RETAIL'
SELECT * FROM CatalogHotelReport WHERE ReportType='DISTRIBUTION_ISSUES'
| Name | Type | References | Description |
| CatalogId | String | Unique identifier of a catalog. | |
| CatalogName | String | CatalogName. | |
| DataSourceId | String | DataSourceId. | |
| DataSourceName | String | DataSourceName. | |
| MerchantHotelId | String | MerchantHotelId. | |
| Name | String | Name. | |
| IneligibleForOrganic | String | IneligibleForOrganic. | |
| IneligibleForAds | String | IneligibleForAds. | |
| CodeLabel | String | CodeLabel. | |
| Message | String | Message. | |
| Link | String | Link. | |
| ImageLink | String | ImageLink. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CatalogType | String | Type of the catalog entity.
The allowed values are RETAIL, HOTEL, CREATIVE_ASSETS. | |
| ReportType | String | Report Type.
The allowed values are FEED_INGESTION_ISSUES, DISTRIBUTION_ISSUES, ALL_ITEMS. | |
| FeedId | String | ID of the feed entity. | |
| ProcessingResultId | String | Unique identifier of a feed processing result. | |
| AdAccountId | String | Unique identifier of an ad account. |
Returns item-level issues detected during catalog processing.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
FeedProcessingResultId is a required column to access this view.
| Column | Supported Operators |
| ItemNumber | = |
| AdAccountId | = |
| ItemValidationIssue | = |
For example:
SELECT * FROM CatalogProcessingResultItemIssues WHERE FeedProcessingResultId = '1249732834965724159'
SELECT * FROM CatalogProcessingResultItemIssues WHERE FeedProcessingResultId = '1249732834965724159' AND ItemNumber = '0'
SELECT * FROM CatalogProcessingResultItemIssues WHERE FeedProcessingResultId = '1249732834965724159' AND AdAccountId = '549768518755'
| Name | Type | References | Description |
| ItemId [KEY] | String | The merchant-created unique ID that represents the product. | |
| FeedProcessingResultId | String | Unique identifier of a feed processing result. | |
| ItemNumber | Integer | Item number based on order of appearance in the Catalogs Feed. | |
| ErrorAdultInvalidName | String | Item attribute that has an invalid adult value. | |
| ErrorAdultInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorAdwordsFormatInvalidName | String | Item has an ad link URL that is duplicate of the link URL. | |
| ErrorAdwordsFormatInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorAvailabilityInvalidName | String | Item is missing availability value in its product metadata, this item will not be published. | |
| ErrorAvailabilityInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorBlocklistedImageSignatureName | String | Item will not be published because it doesn't meet Pinterest's Merchant Guidelines. | |
| ErrorBlocklistedImageSignatureValue | String | Provided value that caused the validation issue. | |
| ErrorDescriptionMissingName | String | Item is missing description in its product metadata, this item will not be published. | |
| ErrorDescriptionMissingValue | String | Provided value that caused the validation issue. | |
| ErrorDuplicateProductsName | String | This product is duplicated. The duplicate entry will not be published. | |
| ErrorDuplicateProductsValue | String | Provided value that caused the validation issue. | |
| ErrorImageLinkInvalidName | String | Image link is invalid. | |
| ErrorImageLinkInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorImageLinkLengthTooLongName | String | Item has image_link URL that contains too many characters, so the item will not be published. | |
| ErrorImageLinkLengthTooLongValue | String | Provided value that caused the validation issue. | |
| ErrorImageLinkMissingName | String | Item is missing an image link URL in its product metadata, this item will not be published. | |
| ErrorImageLinkMissingValue | String | Provided value that caused the validation issue. | |
| ErrorInvalidDomainName | String | Product link value doesn't match the verified domain associated with this account. | |
| ErrorInvalidDomainValue | String | Provided value that caused the validation issue. | |
| ErrorItemIdMissingName | String | Item is missing item id in its product metadata, this item will not be published. | |
| ErrorItemIdMissingValue | String | Provided value that caused the validation issue. | |
| ErrorItemMainImageDownloadFailureName | String | Main image can't be found. | |
| ErrorItemMainImageDownloadFailureValue | String | Provided value that caused the validation issue. | |
| ErrorLinkFormatInvalidName | String | Link is invalid. | |
| ErrorLinkFormatInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorLinkLengthTooLongName | String | Product link contains too many characters, this item will not be published. | |
| ErrorLinkLengthTooLongValue | String | Provided value that caused the validation issue. | |
| ErrorListPriceInvalidName | String | Item has a list price formatting error, this item will not be published. | |
| ErrorListPriceInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorMaxItemsPerItemGroupExceededName | String | Item exceed the maximum number of items per item group, this item will not be published. | |
| ErrorMaxItemsPerItemGroupExceededValue | String | Provided value that caused the validation issue. | |
| ErrorParseLineErrorName | String | Item contains formating errors. | |
| ErrorParseLineErrorValue | String | Provided value that caused the validation issue. | |
| ErrorPinJoinContentUnsafeName | String | Item will not be published because it doesn't meet Pinterest's Merchant Guidelines. | |
| ErrorPinJoinContentUnsafeValue | String | Provided value that caused the validation issue. | |
| ErrorPriceCannotBeDeterminedName | String | Item price cannot be determined because the price, list price, and sale price are all different. | |
| ErrorPriceCannotBeDeterminedValue | String | Provided value that caused the validation issue. | |
| ErrorPriceMISSINGName | String | Product is missing a price, this item will not be published. | |
| ErrorPriceMISSINGValue | String | Provided value that caused the validation issue. | |
| ErrorProductLinkMissingName | String | Item is missing a link URL in its product metadata, this item will not be published. | |
| ErrorProductLinkMissingValue | String | Provided value that caused the validation issue. | |
| ErrorProductPriceInvalidName | String | Item has a price formatting error in its product metadata, this item will not be published. | |
| ErrorProductPriceInvalidValue | String | Provided value that caused the validation issue. | |
| ErrorTitleMissingName | String | Item is missing title in its product metadata, this item will not be published. | |
| ErrorTitleMissingValue | String | Provided value that caused the validation issue. | |
| WarningAdLinkFormatWarningName | String | Item has an ad link that is formatted incorrectly. | |
| WarningAdLinkFormatWarningValue | String | Provided value that caused the validation issue. | |
| WarningAdLinkSameAsLinkName | String | Item has an ad link URL that is duplicate of the link URL. | |
| WarningAdLinkSameAsLinkValue | String | Provided value that caused the validation issue. | |
| WarningAdditionalImageLinkLengthTooLongName | String | Item has an additional_image_link URL that contains too many characters, so the item will not be published. | |
| WarningAdditionalImageLinkLengthTooLongValue | String | Provided value that caused the validation issue. | |
| WarningAdditionalImageLinkWarningName | String | Item has additional_image_link URLs that are formatted incorrectly and will not be published with your items. | |
| WarningAdditionalImageLinkWarningValue | String | Provided value that caused the validation issue. | |
| WarningAdwordsFormatWarningName | String | Item has an adwords_redirect link that is formatted incorrectly. | |
| WarningAdwordsFormatWarningValue | String | Provided value that caused the validation issue. | |
| WarningAdwordsSameAsLinkName | String | Item has an adwords_redirect URL that is duplicate of the link URL. | |
| WarningAdwordsSameAsLinkValue | String | Provided value that caused the validation issue. | |
| WarningAgeGroupInvalidName | String | Item has an age group value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningAgeGroupInvalidDValue | String | Provided value that caused the validation issue. | |
| WarningSizeSystemInvalidName | String | Some items have size system values which are not one of the supported size systems. | |
| WarningSizeSystemInvalidValue | String | Provided value that caused the validation issue. | |
| WarningAndroidDeepLinkInvalidName | String | Item includes an invalid android_deep_link. | |
| WarningAndroidDeepLinkInvalidValue | String | Provided value that caused the validation issue. | |
| WarningAvailabilityDateInvalidName | String | Item has an availability_date value that is formatted incorrectly, this item will be published without an availability date. | |
| WarningAvailabilityDateInvalidValue | String | Provided value that caused the validation issue. | |
| WarningConutryDoesNotMapToCurrencyName | String | Item includes a currency that doesn't match the usual currency for the location where the product is sold or shipped. | |
| WarningCountryDoesNotMapToCurrencyValue | String | Provided value that caused the validation issue. | |
| WarningCustomLabelLengthTooLongName | String | Item has a custom_label value that is too long, this item will be published without that custom label. | |
| WarningCustomLabelLengthTooLongValue | String | Provided value that caused the validation issue. | |
| WarningDescriptionLengthTooLongName | String | The description for this item was truncated because it contains too many characters. | |
| WarningDescriptionLengthTooLongValue | String | Provided value that caused the validation issue. | |
| WarningExpirationDateInvalidName | String | Item has an expiration_date value that is formatted incorrectly, this item will be published without an expiration date. | |
| WarningExpirationDateInvalidValue | String | Provided value that caused the validation issue. | |
| WarningGenderInvalidName | String | Item has a gender value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningGenderInvalidValue | String | Provided value that caused the validation issue. | |
| WarningGTINInvalidName | String | Item has a GTIN value that is formatted incorrectly. | |
| WarningGTINInvalidValue | String | Provided value that caused the validation issue. | |
| WarningImageLinkWarningName | String | Item has an image_link URL that is formatted incorrectly and will not be published. | |
| WarningImageLinkWarningValue | String | Provided value that caused the validation issue. | |
| WarningIOSDeepLinkInvalidName | String | Item includes an invalid ios_deep_link value. | |
| WarningIOSDeepLinkInvalidValue | String | Provided value that caused the validation issue. | |
| WarningIsBundleInvalidName | String | Item has an is_bundle value that is formatted incorrectly, this item will be published without being bundled with other products. | |
| WarningIsBundleInvalidValue | String | Provided value that caused the validation issue. | |
| WarningItemAdditionalImageDownloadFailureName | String | Item includes additional_image_links that can't be found. | |
| WarningItemAdditionalImageDownloadFailureValue | String | Provided value that caused the validation issue. | |
| WarningLinkFormatWarningName | String | Item has an invalid product link which contains invalid UTM tracking paramaters. | |
| WarningLinkFormatWarningValue | String | Provided value that caused the validation issue. | |
| WarningMinAdPriceInvalidName | String | Item includes a min_ad_price value that is formatted incorrectly. | |
| WarningMinAdPriceInvalidValue | String | Provided value that caused the validation issue. | |
| WarningMPNInvalidName | String | Item has a MPN value that is formatted incorrectly. | |
| WarningMPNInvalidValue | String | Provided value that caused the validation issue.. | |
| WarningMultipackInvalidName | String | Item has an invalid multipack value. | |
| WarningMultipackInvalidValue | String | Provided value that caused the validation issue. | |
| WarningOptionalConditionInvalidName | String | Item includes a condition value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningOptionalConditionInvalidValue | String | Provided value that caused the validation issue. | |
| WarningOptionalConditionMissingName | String | Item is missing condition value, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningOptionalConditionMissingValue | String | Provided value that caused the validation issue. | |
| WarningOptionalProductCategoryInvalidName | String | Item includes a google_product_category value that is not formatted correctly according to the GPC taxonomy. | |
| WarningOptionalProductCategoryInvalidValue | String | Provided value that caused the validation issue. | |
| WarningOptionalProductCategoryMissingName | String | Item is missing google_product_category. | |
| WarningOptionalProductCategoryMissingValue | String | Provided value that caused the validation issue. | |
| WarningProductCategoryDepthWarningName | String | Item only has 1 or 2 levels of google_product_category value, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningProductCategoryDepthWarningValue | String | Provided value that caused the validation issue. | |
| WarningProductTypeLengthTooLongName | String | Item has a product_type value that is too long, this item will be published without that product type. | |
| WarningProductTypeLengthTooLongValue | String | Provided value that caused the validation issue. | |
| WarningSalesPriceInvalidName | String | Item has an incorrectly formatted sales price. | |
| WarningSalesPriceInvalidValue | String | Provided value that caused the validation issue. | |
| WarningSalesPriceTooLowName | String | Item has a sale price value that is discounted very low compared to the price. | |
| WarningSalesPriceTooLowValue | String | Provided value that caused the validation issue. | |
| WarningSalesPriceTooHighName | String | Item has a sale price value that is higher than the original price of the item. | |
| WarningSalesPriceTooHighValue | String | Provided value that caused the validation issue. | |
| WarningSaleDateInvalidName | String | Item has a sale_price_effective_date value that is formatted incorrectly, this item will be published without a sale date. | |
| WarningSaleDateInvalidValue | String | Provided value that caused the validation issue. | |
| WarningShippingInvalidName | String | Item has a shipping value that is formatted incorrectly. | |
| WarningShippingInvalidValue | String | Provided value that caused the validation issue. | |
| WarningShippingHeightInvalidName | String | Item has an incorrectly formatted shipping_height value. The value must first contain a numeric value then a valid dimension unit type. | |
| WarningShippingHeightInvalidValue | String | Provided value that caused the validation issue. | |
| WarningShippingWeightInvalidName | String | Item has an invalid shipping_weight value. | |
| WarningShippingWeightInvalidValue | String | Provided value that caused the validation issue. | |
| WarningShippingWidthInvalidName | String | Item has an incorrectly formatted shipping_width value. The value must first contain a numeric value then a valid dimension unit type. | |
| WarningShippingWidthInvalidValue | String | Provided value that caused the validation issue. | |
| WarningSizeTypeInvalidName | String | Item has a size type value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| WarningSizeTypeInvalidValue | String | Provided value that caused the validation issue. | |
| WarningTaxInvalidName | String | Item has a tax value that is formatted incorrectly. | |
| WarningTaxInvalidValue | String | Provided value that caused the validation issue. | |
| WarningTitleLengthTooLongName | String | The title for the item was truncated because it contains too many characters. | |
| WarningTitleLengthTooLongValue | String | Provided value that caused the validation issue. | |
| WarningTooManyAdditionalImageLinksName | String | Item has a additional_image_link value that exceed the limit for additional images, this item will be published without some of your images. | |
| WarningTooManyAdditionalImageLinksValue | String | Provided value that caused the validation issue. | |
| WarningUTMSourceAutoCorrectedName | String | Item includes an utm_source value that is formatted incorrectly and has been automatically corrected. | |
| WarningUTMSourceAutoCorrectedValue | String | Provided value that caused the validation issue. | |
| WarningWeightUnitInvalidName | String | Item has a weight_unit value that is formatted incorrectly, this item will be published without a weight unit. | |
| WarningWeightUnitInvalidValue | String | Provided value that caused the validation issue. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. | |
| ItemValidationIssue | String | Filter item validation issues that have a given type of item validation issue. |
Returns the retail catalog processing report with status, run timestamps, item counts, and error summaries.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| CatalogId | = |
| CatalogType | = |
| ReportType | = |
| FeedId | = |
| ProcessingResultId | = |
| AdAccountId | = |
For example:
SELECT * FROM CatalogRetailReport
SELECT * FROM CatalogRetailReport WHERE CatalogId='4853306950123'
SELECT * FROM CatalogRetailReport WHERE AdAccountId = '549768233165'
SELECT * FROM CatalogRetailReport WHERE CatalogType = 'RETAIL'
SELECT * FROM CatalogRetailReport WHERE ReportType='DISTRIBUTION_ISSUES'
| Name | Type | References | Description |
| CatalogId | String | Unique identifier of a catalog. | |
| CatalogName | String | CatalogName. | |
| DataSourceId | String | DataSourceId. | |
| DataSourceName | String | DataSourceName. | |
| ItemId | String | ItemId. | |
| Title | String | Title. | |
| IneligibleForOrganic | String | IneligibleForOrganic. | |
| IneligibleForAds | String | IneligibleForAds. | |
| CodeLabel | String | CodeLabel. | |
| Message | String | Message. | |
| Link | String | Link. | |
| ImageLink | String | ImageLink. | |
| Price | String | Price. | |
| Availability | String | Availability. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CatalogType | String | Type of the catalog entity.
The allowed values are RETAIL, HOTEL, CREATIVE_ASSETS. | |
| ReportType | String | Report Type.
The allowed values are FEED_INGESTION_ISSUES, DISTRIBUTION_ISSUES, ALL_ITEMS. | |
| FeedId | String | ID of the feed entity. | |
| ProcessingResultId | String | Unique identifier of a feed processing result. | |
| AdAccountId | String | Unique identifier of an ad account. |
Returns catalogs owned by the user account associated with the operation.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM Catalogs WHERE AdAccountId = '549768233165'
| Name | Type | References | Description |
| Id [KEY] | String | ID of the catalog entity. | |
| Name | String | A human-friendly name associated to a catalog entity. | |
| CreatedAt | Datetime | CreatedAt time. | |
| UpdatedAt | Datetime | UpdatedAt time. | |
| CatalogType | String | Type of the catalog entity.
The allowed values are RETAIL, HOTEL, CREATIVE_ASSETS. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Retrieve the items from the catalog that are classified as CREATIVE_ASSETS and are owned by the user account associated with the operation.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud. Country, Language, CatalogType, and CreativeAssetsId are required columns to access this view.
| Column | Supported Operators |
| CatalogId | = |
| CatalogType | = |
| CreativeAssetsId | = |
| Country | = |
| Language | = |
| AdAccountId | = |
For example:
SELECT * FROM CatalogTypeCreativeAssetsItems WHERE Country='US' AND Language='en-US' AND CatalogType = 'CREATIVE_ASSETS' AND CreativeAssetsId = '1122,07'
| Name | Type | References | Description |
| CreativeAssetsId | String | The catalog creative assets id in the merchant namespace. | |
| CatalogType | String | Type of the catalog entity. | |
| CatalogId | String | Catalog id pertaining to the creative assets item. If not provided, default to oldest creative assets catalog. | |
| Country | String | Country ID from ISO 3166-1 alpha-2. | |
| Language | String | Catalog Language. | |
| AttributesAdditionalImagelink | String | The links to additional images for your product.Must start with http:// or https://. | |
| AttributesImageLink | String | The creative assets image.Must start with http:// or https://. | |
| AttributesVideoLink | String | The creative assets video. | |
| AttributesAdLink | String | Allows advertisers to set a separate tracking URL for Pinterest shopping ads. Provide the full URL, including tracking parameters, and make sure it begins with http:// or https://. | |
| AttributesAdult | Boolean | Set this attribute to TRUE if you're submitting items that are considered adult. These will not be shown on Pinterest. | |
| AttributesAgeGroup | String | The age group to apply a demographic range to the product.
The allowed values are newborn, infant, toddler, kids, adult. | |
| AttributesAvailability | String | The availability of the product.
The allowed values are in stock, out of stock, preorder. | |
| AttributesAverageReviewRating | Integer | Average reviews for the item. Can be a number from 1-5. | |
| AttributesBrand | String | The brand of the product. | |
| AttributesColor | String | The primary color of the product. | |
| AttributesCondition | String | The condition of the product.
The allowed values are new, used, refurbished. | |
| AttributesCustomLabel0 | String | Custom grouping of creative assets. | |
| AttributesCustomLabel1 | String | Custom grouping of creative assets. | |
| AttributesCustomLabel2 | String | Custom grouping of creative assets. | |
| AttributesCustomLabel3 | String | Custom grouping of creative assets. | |
| AttributesCustomLabel4 | String | Custom grouping of creative assets. | |
| AttributesCustomNumber0 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber1 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber2 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber3 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber4 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesDescription | String | Brief description of the creative assets.. | |
| AttributesFreeShippingLabel | Boolean | The item is free to ship. | |
| AttributesFreeShippingLimit | String | The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered. | |
| AttributesGender | String | The gender associated with the product.
The allowed values are male, female, unisex. | |
| AttributesGoogleProductCategory | String | The categorization of the product based on the standardized Google Product Taxonomy. | |
| AttributesGtin | Long | The unique universal product identifier. | |
| AttributesItemGroupId | String | The parent ID of the product. | |
| AttributesLastUpdatedTime | Datetime | The millisecond timestamp when the item was lastly modified by the merchant. | |
| AttributesLink | String | Link to the creative assets page. | |
| AttributesMaterial | String | The material used to make the product. | |
| AttributesMinAdPrice | String | The minimum advertised price of the product. | |
| AttributesMobileLink | String | The mobile-optimized version of your landing page. Must begin with http:// or https://. | |
| AttributesMpn | String | Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer. | |
| AttributesNumberOfRatings | Integer | The number of ratings for the item. | |
| AttributesNumberOfReviews | Integer | The number of reviews available for the item. | |
| AttributesPattern | String | The description of the pattern used for the product. | |
| AttributesPrice | String | The price of the product. | |
| AttributesProductType | String | The categorization of your product based on your custom product taxonomy. | |
| AttributesSalePrice | String | The discounted price of the product. The sale_price must be lower than the price. | |
| AttributesShipping | String | Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). | |
| AttributesShippingHeight | String | The height of the package needed to ship the product. | |
| AttributesShippingWeight | String | The weight of the product. | |
| AttributesShippingWidth | String | The width of the package needed to ship the product. | |
| AttributesSize | String | The size of the product. | |
| AttributesSizeSystem | String | Indicates the country's sizing system in which you are submitting your product.
The allowed values are US, UK, EU, DE, FR, JP, CN, IT, BR, MEX, AU. | |
| AttributesSizeType | String | Additional description for the size.
The allowed values are regular, petite, plus, big_and_tall, maternity. | |
| AttributesTax | String | Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). | |
| AttributesTitle | String | The name of the creative assets. | |
| AttributesVariantNames | String | Options for this variant. People will see these options next to your Pin and can select the one they want. | |
| AttributesVariantValues | String | Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. | |
| AttributesIosDeepLink | String | IOS deep link to the creative assets page. | |
| AttributesAndroidDeepLink | String | Link to the creative assets page. | |
| AttributesVisibility | String | Visibility of the creative assets. | |
| AttributesInstallmentPrice | String | Installment price of the product. | |
| AttributesPromotionId | String | A unique identifier referencing the promotion associated with this catalog item. | |
| AttributesSalePriceEffectiveDate | Date | Sale price effective date. | |
| AttributesUnitPricingBaseMeasure | String | Unit pricing base measure of the product. | |
| AttributesUnitPricingMeasure | String | Unit pricing total measure of the product. | |
| ItemResponseKind | String | Discriminator literal identifying the item leaf inside the response payload. | |
| Pins | String | The pins mapped to the item. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Retrieve items from the operating user's HOTEL catalog.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud. Country, Language, CatalogType, and HotelId are required columns to access this view.
| Column | Supported Operators |
| CatalogId | = |
| CatalogType | = |
| HotelId | = |
| Country | = |
| Language | = |
| AdAccountId | = |
SELECT * FROM CatalogTypeHotelItems WHERE Country='US' AND Language='en-US' AND CatalogType = 'HOTEL' AND HotelId = '1122,07'
| Name | Type | References | Description |
| HotelId | String | The catalog hotel id in the merchant namespace. | |
| CatalogType | String | Type of the catalog entity. | |
| CatalogId | String | Catalog id pertaining to the hotel item. If not provided, default to oldest hotel catalog. | |
| Country | String | Country ID from ISO 3166-1 alpha-2. | |
| Language | String | Catalog Language. | |
| AttributesAdditionalImagelink | String | The links to additional images for your hotel. Up to ten additional images can be used to show a hotel from different angles. Must begin with http:// or https://. | |
| AttributesImageLink | String | The link to the main product images.Must start with http:// or https://. | |
| AttributesVideoLink | String | Hosted link to the product video. | |
| AttributesAdLink | String | Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking?do not send tracking parameters only.Must start with http:// or https://. | |
| AttributesAdult | Boolean | Set this attribute to TRUE if you're submitting items that are considered adult. These will not be shown on Pinterest. | |
| AttributesAgeGroup | String | The age group to apply a demographic range to the product.
The allowed values are newborn, infant, toddler, kids, adult. | |
| AttributesAvailability | String | The availability of the product.
The allowed values are in stock, out of stock, preorder. | |
| AttributesAverageReviewRating | Integer | Average reviews for the item. Can be a number from 1-5. | |
| AttributesBrand | String | The brand of the product. | |
| AttributesColor | String | The primary color of the product. | |
| AttributesCondition | String | The condition of the product.
The allowed values are new, used, refurbished. | |
| AttributesCustomLabel0 | String | Custom grouping of hotels. | |
| AttributesCustomLabel1 | String | Custom grouping of hotels. | |
| AttributesCustomLabel2 | String | Custom grouping of hotels. | |
| AttributesCustomLabel3 | String | Custom grouping of hotels. | |
| AttributesCustomLabel4 | String | Custom grouping of hotels. | |
| AttributesCustomNumber0 | Integer | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber1 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber2 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber3 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber4 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesDescription | String | Brief description of the hotel. | |
| AttributesFreeShippingLabel | Boolean | The item is free to ship. | |
| AttributesFreeShippingLimit | String | The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered. | |
| AttributesGender | String | The gender associated with the product.
The allowed values are male, female, unisex. | |
| AttributesGoogleProductCategory | String | The categorization of the product based on the standardized Google Product Taxonomy. | |
| AttributesGtin | Long | The unique universal product identifier. | |
| AttributesItemGroupId | String | The parent ID of the product. | |
| AttributesLastUpdatedTime | Datetime | The millisecond timestamp when the item was lastly modified by the merchant. | |
| AttributesLink | String | The landing page for the product. | |
| AttributesMaterial | String | The material used to make the product. | |
| AttributesMinAdPrice | String | The minimum advertised price of the product. | |
| AttributesMobileLink | String | The mobile-optimized version of your landing page. Must begin with http:// or https://. | |
| AttributesMpn | String | Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer. | |
| AttributesNumberOfRatings | Integer | The number of ratings for the item. | |
| AttributesNumberOfReviews | Integer | The number of reviews available for the item. | |
| AttributesPattern | String | The description of the pattern used for the product. | |
| AttributesPrice | String | The price of the product. | |
| AttributesProductType | String | The categorization of your product based on your custom product taxonomy. | |
| AttributesSalePrice | String | The discounted price of the product. The sale_price must be lower than the price. | |
| AttributesShipping | String | Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). | |
| AttributesShippingHeight | String | The height of the package needed to ship the product. | |
| AttributesShippingWeight | String | The weight of the product. | |
| AttributesShippingWidth | String | The width of the package needed to ship the product. | |
| AttributesSize | String | The size of the product. | |
| AttributesSizeSystem | String | Indicates the country?s sizing system in which you are submitting your product.
The allowed values are US, UK, EU, DE, FR, JP, CN, IT, BR, MEX, AU. | |
| AttributesSizeType | String | Additional description for the size.
The allowed values are regular, petite, plus, big_and_tall, maternity. | |
| AttributesTax | String | Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). | |
| AttributesTitle | String | The title of the product. | |
| AttributesVariantNames | String | Options for this variant. People will see these options next to your Pin and can select the one they want. | |
| AttributesVariantValues | String | Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. | |
| AttributesMainImageLink | String | The link to the main hotel image. Image should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your hotel. | |
| AttributesMainImageTag | String | Tag appended to the image that identifies image category or details. There can be multiple tags associated with an image. | |
| AttributesLatitude | Integer | Latitude of the hotel. | |
| AttributesLongitude | Integer | Longitude of the hotel. | |
| AttributesNeighborhood | String | A list of neighborhoods where the hotel is located. | |
| AttributesAddressAddr1 | String | Primary street address of hotel. | |
| AttributesAddressCity | String | City where the hotel is located. | |
| AttributesAddressRegion | String | State, county, province, where the hotel is located. | |
| AttributesAddressCountry | String | Country where the hotel is located. | |
| AttributesAddressPostalCode | String | Required for countries with a postal code system. Postal or zip code of the hotel. | |
| AttributesCategory | String | The type of property. The category can be any type of internal description desired. | |
| AttributesBasePrice | String | Base price of the hotel room per night followed by the ISO currency code. | |
| AttributesGuestRatingsScore | Integer | Your hotel's rating. | |
| AttributesGuestRatingsNumberOfReviewers | Integer | Total number of people who have rated this hotel. | |
| AttributesGuestRatingsMaxScore | Integer | Max value for the hotel rating score. | |
| AttributesGuestRatingSystem | String | System you use for guest reviews. | |
| AttributesAndroidDeepLink | String | The deep link to the product on the Android app. | |
| AttributesId | String | The user-created unique ID that represents the product. Only Unicode characters are accepted. | |
| AttributesInstallmentPrice | String | Installment price of the product. | |
| AttributesIosDeepLink | String | The deep link to the product on the iOS app. | |
| AttributesPromotionId | String | A unique identifier referencing the promotion associated with this catalog item. | |
| AttributesSalePriceEffectiveDate | Date | Sale price effective date. | |
| AttributesUnitPricingBaseMeasure | String | Unit pricing base measure of the product. | |
| AttributesUnitPricingMeasure | String | Unit pricing total measure of the product. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Retrieve items from the retail catalog owned by the operating user account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud. Country, Language, CatalogType, and RetailItemId are required columns to access this view.
| Column | Supported Operators |
| CatalogId | = |
| CatalogType | = |
| RetailItemId | = |
| Country | = |
| Language | = |
| AdAccountId | = |
SELECT * FROM CatalogTypeRetailItems WHERE Country='US' AND Language='en-US' AND CatalogType = 'RETAIL' AND RetailItemId = '31176763998231,39870493392919,39870493458455'
| Name | Type | References | Description |
| RetailItemId | String | The catalog retail item id in the merchant namespace. | |
| CatalogType | String | Type of the catalog entity. | |
| CatalogId | String | Catalog id pertaining to the retail item. If not provided, default to oldest retail catalog. | |
| Country | String | Country ID from ISO 3166-1 alpha-2. | |
| Language | String | Catalog Language. | |
| AttributesAdditionalImagelink | String | The links to additional images for your product.Must start with http:// or https://. | |
| AttributesImageLink | String | The link to the main product images.Must start with http:// or https://. | |
| AttributesVideoLink | String | Hosted link to the product video. | |
| AttributesAdLink | String | Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking?do not send tracking parameters only.Must start with http:// or https://. | |
| AttributesAdult | Boolean | Set this attribute to TRUE if you're submitting items that are considered adult. These will not be shown on Pinterest. | |
| AttributesAgeGroup | String | The age group to apply a demographic range to the product.
The allowed values are newborn, infant, toddler, kids, adult. | |
| AttributesAvailability | String | The availability of the product.
The allowed values are in stock, out of stock, preorder. | |
| AttributesAverageReviewRating | Integer | Average reviews for the item. Can be a number from 1-5. | |
| AttributesBrand | String | The brand of the product. | |
| AttributesColor | String | The primary color of the product. | |
| AttributesCondition | String | The condition of the product.
The allowed values are new, used, refurbished. | |
| AttributesCustomLabel0 | String | Custom grouping of products. | |
| AttributesCustomLabel1 | String | Custom grouping of products. | |
| AttributesCustomLabel2 | String | Custom grouping of products. | |
| AttributesCustomLabel3 | String | Custom grouping of products. | |
| AttributesCustomLabel4 | String | Custom grouping of products. | |
| AttributesCustomNumber0 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber1 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber2 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber3 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesCustomNumber4 | Long | An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items. | |
| AttributesDescription | String | The description of the product. | |
| AttributesFreeShippingLabel | Boolean | The item is free to ship. | |
| AttributesFreeShippingLimit | String | The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered. | |
| AttributesGender | String | The gender associated with the product.
The allowed values are male, female, unisex. | |
| AttributesGoogleProductCategory | String | The categorization of the product based on the standardized Google Product Taxonomy. | |
| AttributesGtin | Long | The unique universal product identifier. | |
| AttributesItemGroupId | String | The parent ID of the product. | |
| AttributesLastUpdatedTime | Datetime | The millisecond timestamp when the item was lastly modified by the merchant. | |
| AttributesLink | String | The landing page for the product. | |
| AttributesMaterial | String | The material used to make the product. | |
| AttributesMinAdPrice | String | The minimum advertised price of the product. | |
| AttributesMobileLink | String | The mobile-optimized version of your landing page. Must begin with http:// or https://. | |
| AttributesMpn | String | Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer. | |
| AttributesNumberOfRatings | Integer | The number of ratings for the item. | |
| AttributesNumberOfReviews | Integer | The number of reviews available for the item. | |
| AttributesPattern | String | The description of the pattern used for the product. | |
| AttributesPrice | String | The price of the product. | |
| AttributesProductType | String | The categorization of your product based on your custom product taxonomy. | |
| AttributesSalePrice | String | The discounted price of the product. The sale_price must be lower than the price. | |
| AttributesShipping | String | Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required). | |
| AttributesShippingHeight | String | The height of the package needed to ship the product. | |
| AttributesShippingWeight | String | The weight of the product. | |
| AttributesShippingWidth | String | The width of the package needed to ship the product. | |
| AttributesSize | String | The size of the product. | |
| AttributesSizeSystem | String | Indicates the country?s sizing system in which you are submitting your product.
The allowed values are US, UK, EU, DE, FR, JP, CN, IT, BR, MEX, AU. | |
| AttributesSizeType | String | Additional description for the size.
The allowed values are regular, petite, plus, big_and_tall, maternity. | |
| AttributesTax | String | Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional). | |
| AttributesTitle | String | The name of the product. | |
| AttributesVariantNames | String | Options for this variant. People will see these options next to your Pin and can select the one they want. | |
| AttributesVariantValues | String | Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Get information about the conversion tags in an ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Id | = |
| FilterDeleted | = |
For example:
SELECT * FROM ConversionTags WHERE AdAccountId = '549768561505'
SELECT * FROM ConversionTags WHERE AdAccountId = '549768561505' AND Id = '2617998078212'
| Name | Type | References | Description |
| Id [KEY] | String | Tag ID. | |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account this conversion tag belongs to. |
| Name | String | Conversion tag name. | |
| Status | String | Entity status of the conversion tag.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| Version | String | Version number. | |
| CodeSnippet | String | Tag code snippet. | |
| EnhancedMatchStatus | String | The enhanced match status of the tag.
The allowed values are UNKNOWN, NOT_VALIDATED, VALIDATING_IN_PROGRESS, VALIDATION_COMPLETE. | |
| LastFiredTime | Datetime | Time for the last event fired. | |
| Configs | String | The configuration settings of the conversion tag. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| FilterDeleted | Boolean | Filter conversion tags by deleted status.
The default value is false. |
Get a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountID | = |
| ID | = |
| Order | = |
For example:
SELECT * FROM CustomerLists
SELECT * FROM CustomerLists WHERE AdAccountId = '547362621403'
SELECT * FROM CustomerLists WHERE Id = '12575858432'
SELECT * FROM CustomerLists WHERE [Order] = 'ASCENDING'
| Name | Type | References | Description |
| AdAccountID | String |
AdAccounts.Id | Associated ad account ID. |
| Id | String | Customer list ID. | |
| Name | String | Customer list name. | |
| CreatedTime | Datetime | Creation time. Unix timestamp in seconds. | |
| UpdatedTime | Datetime | Last update time. Unix timestamp in seconds. | |
| NumBatches | Integer | Total number of list updates. | |
| NumRemovedUserRecords | Integer | Number of removed user records. | |
| NumUploadedUserRecords | Integer | Number of uploaded user records. | |
| Status | String | Customer list status. TOO_SMALL - the list has less than 100 Pinterest users.
The allowed values are PROCESSING, READY, TOO_SMALL, UPLOADING. | |
| Type | String | Always customerlist | |
| Exceptions | String | Customer list errors. |
Get the metadata for a customer list upload by its ID.
The Cloud 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 Cloud. AdAccountId, CustomerListId, and Id are required columns to access this table.
SELECT * FROM CustomerListUpload WHERE AdAccountId = '549755885175' AND CustomerListId = '2542620905475' AND Id = '2680059592705'
SELECT * FROM CustomerListUpload WHERE AdAccountId = '549755885175' AND CustomerListId = '2542620905475' AND Id IN ('2680059592705','2542620905475')
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier of the customer list upload. | |
| AdAccountId | String |
AdAccounts.Id | Unique identifier of an ad account. |
| CustomerListId | String | Unique identifier of the customer list associated with this upload. | |
| Operation | String | Operation type for the upload.
The allowed values are ADD, REMOVE. | |
| State | String | Workload processing state of the upload.
The allowed values are NOT_STARTED, RUNNING, PAUSED, SUCCEEDED, FAILED. | |
| CreationTime | Datetime | Customer list upload creation time. Epoch (seconds). | |
| UpdatedTime | Datetime | Customer list upload last updated time. Epoch (seconds). | |
| RecordCountsProcessed | Integer | Number of records processed. | |
| RecordCountsValid | Integer | Number of valid records processed. | |
| RecordCountsInvalid | Integer | Number of invalid records processed. | |
| ErrorCounts | String | Error counts by error code. Each entry contains error_code, message, and count. |
Get a list of published editorial articles for a given region. Translations are provided when available; otherwise the default language is English.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
Region is a required column to query this view.
| Column | Supported Operators |
| Region | = |
For example:
SELECT * FROM EditorialArticles WHERE Region = 'US'
| Name | Type | References | Description |
| Region | String | The geographic region of interest, formatted as ISO 3166-2 country codes delimited by '+' (for example US, GB+IE, CA). | |
| Title | String | Title of the editorial article. | |
| Description | String | Description of the editorial article. | |
| BoardUrl | String | URL of the editorial board. | |
| Interests | String | List of interests related to the editorial article. | |
| PinsUrl | String | URLs of the pins related to the editorial article. | |
| RelatedKeywords | String | List of keywords related to the editorial article. |
Pull the top trending topics by interest and market, at full parity with the Pinterest Trends UI.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
Region is a required column to query this view.
| Column | Supported Operators |
| Region | = |
| Interest | = |
For example:
SELECT * FROM FeaturedTopics WHERE Region = 'US'
SELECT * FROM FeaturedTopics WHERE Region = 'US' AND Interest = 'BEAUTY'
| Name | Type | References | Description |
| Region | String | The geographic region of interest, formatted as ISO 3166-2 country codes delimited by '+' (for example US, GB+IE, CA). | |
| Interest | String | The main interest category.
The allowed values are ALL, ANIMALS, ARCHITECTURE, ART, BEAUTY, DIY_AND_CRAFTS, EDUCATION, EVENT_PLANNING, FASHION, FOOD_AND_DRINKS, GARDENING, HEALTH, HOME_DECOR, PARENTING, TRAVEL, WEDDING. | |
| Market | String | Market code of the trending topics (for example US, GB+IE, CA).
The allowed values are US, GB+IE, CA. | |
| Trends | String | List of trending topics within this interest category. |
Get the individual trending topics within the featured topics for a given interest and market. Child view of FeaturedTopics.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
Region is a required column to query this view.
| Column | Supported Operators |
| Region | = |
| Interest | = |
For example:
SELECT * FROM FeaturedTopicsTrends WHERE Region = 'US'
SELECT * FROM FeaturedTopicsTrends WHERE Region = 'US' AND Interest = 'BEAUTY'
| Name | Type | References | Description |
| Region | String | The geographic region of interest, formatted as ISO 3166-2 country codes delimited by '+' (for example US, GB+IE, CA). | |
| Interest | String | The main interest category the trending topics belong to.
The allowed values are ALL, ANIMALS, ARCHITECTURE, ART, BEAUTY, DIY_AND_CRAFTS, EDUCATION, EVENT_PLANNING, FASHION, FOOD_AND_DRINKS, GARDENING, HEALTH, HOME_DECOR, PARENTING, TRAVEL, WEDDING. | |
| Id [KEY] | String | Unique identifier for the trending topic. | |
| Title | String | Title of the trending topic. | |
| Description | String | Description of the trending topic. | |
| PercentGrowthMom | Integer | Month-over-month growth percentage. | |
| RelatedInterests | String | List of related interest categories. | |
| RelatedSearches | String | List of related search terms. | |
| TimeSeries | String | Time series data showing trend values over time, with dates as keys and numeric values. | |
| Pins | String | Array of pin images related to this trend (up to 6). |
Returns processing results for feeds, including status, run timestamps, item counts, and error summaries.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
FeedId is a required column to access this view.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM FeedProcessingResults WHERE FeedId = '1540904175633'
SELECT * FROM FeedProcessingResults WHERE FeedId = '1540904175633' AND AdAccountId = '549768518755'
| Name | Type | References | Description |
| Id [KEY] | String | Feed Processing Result ID. | |
| FeedId | String |
Feeds.Id | Unique identifier of a feed. |
| CreatedAt | Datetime | CreatedAt time. | |
| UpdatedAt | Datetime | UpdatedAt time. | |
| ProductCountsOriginal | Integer | The number of products in the feed file. | |
| ProductCountsIngested | Integer | The number of products successfully ingested from the feed file. | |
| Status | String | Status.
The allowed values are COMPLETED, FAILED, PROCESSING. | |
| IngestionErrorLineLevelInternalError | Integer | We experienced a technical difficulty and were unable to ingest this some items. The next ingestion will happen in 24 hours. | |
| IngestionErrorLargeProductCountDecrease | Integer | The product count has decreased by more than 99% compared to the last successful ingestion. | |
| IngestionErrorAccountFlagged | Integer | We detected an issue with your account and are not currently ingesting your items. | |
| IngestionErrorImageLevelInternalError | Integer | We experienced a technical difficulty and were unable to download some images. The next download attempt will happen in 24 hours. | |
| IngestionErrorImageFileNotAccessible | Integer | Image files are unreadable. Please upload new files to continue. | |
| IngestionErrorImageMalformedUrl | Integer | Image files are unreadable. Please check your link and upload new files to continue. | |
| IngestionErrorImageFileNotFound | Integer | Image files are unreadable. Please upload new files to continue. | |
| IngestionErrorImageInvalidFile | Integer | Image files are unreadable. Please upload new files to continue. | |
| IngestionErrorFetchGoogleSheetNotShared | Integer | Update your Google Sheets sharing settings to 'Anyone with link' as a Viewer so that Pinterest can access your file. | |
| IngestionInfoInStock | Integer | The number of ingested products that are in stock. | |
| IngestionInfoOutOfStock | Integer | The number of ingested products that are in out of stock. | |
| IngestionInfoPreorder | Integer | The number of ingested products that are in preorder. | |
| IngestionWarningAdditionalImageLevelInternalError | Integer | We experienced a technical difficulty and were unable to download some additional images. The next download attempt will happen in 24 hours. | |
| IngestionWarningAdditionalImageFileNotAccessible | Integer | Additional image files are unreadable. Please upload new files to continue. | |
| IngestionWarningAdditionalImageMalformedUrl | Integer | Additional image files are unreadable. Please check your link and upload new files to continue. | |
| IngestionWarningAdditionalImageFileNotFound | Integer | Additional image files are unreadable. Please upload new files to continue. | |
| IngestionWarningAdditionalImageInvalidFile | Integer | Additional image files are unreadable. Please upload new files to continue. | |
| IngestionWarningHotelPriceHeaderIsPresent | Integer | price is not a supported column. Use base_price and sale_price instead. | |
| IngestionWarningFetchGoogleSheetPublicCanEdit | Integer | Update your Google Sheets sharing settings from 'Editor' to 'Viewer'. | |
| ValidationErrorFetchError | Integer | Pinterest couldn't download your feed. | |
| ValidationErrorFetchInactiveFeedError | Integer | Your feed wasn't ingested because it hasn’t changed in the previous 90 days. | |
| ValidationErrorEncodingError | Integer | Your feed includes data with an unsupported encoding format. | |
| ValidationErrorDelimiterError | Integer | Your feed includes data with formatting errors. | |
| ValidationErrorRequiredColumnsMissing | Integer | Your feed is missing some required column headers. | |
| ValidationErrorDuplicateProducts | Integer | Some products are duplicated. | |
| ValidationErrorImageLinkInvalid | Integer | Some image links are formatted incorrectly. | |
| ValidationErrorItemIdMissing | Integer | Some items are missing an item id in their product metadata, those items will not be published. | |
| ValidationErrorTitleMissing | Integer | Some items are missing a title in their product metadata, those items will not be published. | |
| ValidationErrorDescriptionMissing | Integer | Some items are missing a description in their product metadata, those items will not be published. | |
| ValidationErrorProductLinkMissing | Integer | Some items are missing a link URL in their product metadata, those items will not be published. | |
| ValidationErrorImageLinkMissing | Integer | Some items are missing an image link URL in their product metadata, those items will not be published. | |
| ValidationErrorAvailabilityInvalid | Integer | Some items are missing an availability value in their product metadata, those items will not be published. | |
| ValidationErrorProductPriceInvalid | Integer | Some items have price formatting errors in their product metadata, those items will not be published. | |
| ValidationErrorLinkFormatInvalid | Integer | Some link values are formatted incorrectly. | |
| ValidationErrorParseLineError | Integer | Your feed contains formatting errors for some items. | |
| ValidationErrorAdwordsFormatInvalid | Integer | Some adwords links contain too many characters. | |
| ValidationErrorInternalServiceError | Integer | We experienced a technical difficulty and were unable to ingest your feed. The next ingestion will happen in 24 hours. | |
| ValidationErrorNoVerifiedDomain | Integer | Your merchant domain needs to be claimed. | |
| ValidationErrorAdultInvalid | Integer | Some items have invalid adult values. | |
| ValidationErrorImageLinkLengthTooLong | Integer | Some items have image_link URLs that contain too many characters, so those items will not be published. | |
| ValidationErrorInvalidDomain | Integer | Some of your product link values don't match the verified domain associated with this account. | |
| ValidationErrorFeedLengthTooLong | Integer | Your feed contains too many items, some items will not be published. | |
| ValidationErrorLinkLengthTooLong | Integer | Some product links contain too many characters, those items will not be published. | |
| ValidationErrorMalformedXml | Integer | Your feed couldn't be validated because the xml file is formatted incorrectly. | |
| ValidationErrorPriceMissing | Integer | Some products are missing a price, those items will not be published. | |
| ValidationErrorFeedTooSmall | Integer | Your feed couldn't be validated because the file doesn't contain the minimum number of lines required. | |
| ValidationErrorMaxItemsPerItemGroupExceeded | Integer | Some items exceed the maximum number of items per item group, those items will not be published. | |
| ValidationErrorItemMainImageDownloadFailure | Integer | Some items' main images can't be found. | |
| ValidationErrorPinJoinContentUnsafe | Integer | Some items were not published because they don't meet Pinterest's Merchant Guidelines. | |
| ValidationErrorBlocklistedImageSignature | Integer | Some items were not published because they don't meet Pinterest's Merchant Guidelines. | |
| ValidationErrorListPriceInvalid | Integer | Some items have list price formatting errors in their product metadata, those items will not be published. | |
| ValidationErrorPriceCannotBeDetermined | Integer | Some items were not published because price cannot be determined. The price, list price, and sale price are all different, so those items will not be published. | |
| ValidationWarningAdLinkFormatWarning | Integer | Some items have ad links that are formatted incorrectly. | |
| ValidationWarningAdLinkSameAsLink | Integer | Some items have ad link URLs that are duplicates of the link URLs for those items. | |
| ValidationWarningTitleLengthTooLong | Integer | The title for some items were truncated because they contain too many characters. | |
| ValidationWarningDescriptionLengthTooLong | Integer | The description for some items were truncated because they contain too many characters. | |
| ValidationWarningGenderInvalid | Integer | Some items have gender values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningAgeGroupInvalid | Integer | Some items have age group values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningSizeTypeInvalid | Integer | Some items have size type values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningSizeSystemInvalid | Integer | Some items have size system values which are not one of the supported size systems. | |
| ValidationWarningLinkFormatWarning | Integer | Some items have an invalid product link which contains invalid UTM tracking paramaters. | |
| ValidationWarningSalesPriceInvalid | Integer | Some items have sale price values that are higher than the original price of the item. | |
| ValidationWarningProductCategoryDepthWarning | Integer | Some items only have 1 or 2 levels of google_product_category values, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningAdwordsFormatWarning | Integer | Some items have adwords_redirect links that are formatted incorrectly. | |
| ValidationWarningAdwordsSameAsLink | Integer | Some items have adwords_redirect URLs that are duplicates of the link URLs for those items. | |
| ValidationWarningDuplicateHeaders | Integer | Your feed contains duplicate headers. | |
| ValidationWarningFetchSameSignature | Integer | Ingestion completed early because there are no changes to your feed since the last successful update. | |
| ValidationWarningAdditionalImageLinkLengthTooLong | Integer | Some items have additional_image_link URLs that contain too many characters, so those items will not be published. | |
| ValidationWarningAdditionalImageLinkWarning | Integer | Some items have additional_image_link URLs that are formatted incorrectly and will not be published with your items. | |
| ValidationWarningImageLinkWarning | Integer | Some items have image_link URLs that are formatted incorrectly and will not be published with those items. | |
| ValidationWarningShippingInvalid | Integer | Some items have shipping values that are formatted incorrectly. | |
| ValidationWarningTaxInvalid | Integer | Some items have tax values that are formatted incorrectly. | |
| ValidationWarningShippingWeightInvalid | Integer | Some items have invalid shipping_weight values. | |
| ValidationWarningExpirationDateInvalid | Integer | Some items have expiration_date values that are formatted incorrectly, those items will be published without an expiration date. | |
| ValidationWarningAvailabilityDateInvalid | Integer | Some items have availability_date values that are formatted incorrectly, those items will be published without an availability date. | |
| ValidationWarningSaleDateInvalid | Integer | Some items have sale_price_effective_date values that are formatted incorrectly, those items will be published without a sale date. | |
| ValidationWarningWeightUnitInvalid | Integer | Some items have weight_unit values that are formatted incorrectly, those items will be published without a weight unit. | |
| ValidationWarningIsBundleInvalid | Integer | Some items have is_bundle values that are formatted incorrectly, those items will be published without being bundled with other products. | |
| ValidationWarningUpdatedTimeInvalid | Integer | Some items have updated_time values thate are formatted incorrectly, those items will be published without an updated time. | |
| ValidationWarningCustomLabelLengthTooLong | Integer | Some items have custom_label values that are too long, those items will be published without that custom label. | |
| ValidationWarningProductTypeLengthTooLong | Integer | Some items have product_type values that are too long, those items will be published without that product type. | |
| ValidationWarningTooManyAdditionalImageLinks | Integer | Some items have additional_image_link values that exceed the limit for additional images, those items will be published without some of your images. | |
| ValidationWarningMultipackInvalid | Integer | Some items have invalid multipack values. | |
| ValidationWarningIndexedProductCountLargeDelta | Integer | The product count has increased or decreased significantly compared to the last successful ingestion. | |
| ValidationWarningItemAdditionalImageDownloadFailure | Integer | Some items include additional_image_links that can't be found. | |
| ValidationWarningOptionalProductCategoryMissing | Integer | Some items are missing a google_product_category. | |
| ValidationWarningOptionalProductCategoryInvalid | Integer | Some items include google_product_category values that are not formatted correctly according to the GPC taxonomy. | |
| ValidationWarningOptionalConditionMissing | Integer | Some items are missing a condition value, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningOptionalConditionInvalid | Integer | Some items include condition values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences. | |
| ValidationWarningIosDeepLinkInvalid | Integer | Some items include invalid ios_deep_link values. | |
| ValidationWarningAndroidDeepLinkInvalid | Integer | Some items include invalid android_deep_link. | |
| ValidationWarningUtmSourceAutoCorrected | Integer | Some items include utm_source values that are formatted incorrectly and have been automatically corrected. | |
| ValidationWarningCountryDoesNotMapToCurrency | Integer | Some items include a currency that doesn't match the usual currency for the location where that product is sold or shipped. | |
| ValidationWarningMinAdPriceInvalid | Integer | Some items include min_ad_price values that are formatted incorrectly. | |
| ValidationWarningGtinInvalid | Integer | Some items include incorrectly formatted GTINs. | |
| ValidationWarningInconsistentCurrencyValues | Integer | Some items include inconsistent currencies in price fields. | |
| ValidationWarningSalesPriceTooLow | Integer | Some items include sales price that is much lower than the list price. | |
| ValidationWarningShippingWidthInvalid | Integer | Some items include incorrectly formatted shipping_width. | |
| ValidationWarningShippingHeightInvalid | Integer | Some items include incorrectly formatted shipping_height. | |
| ValidationWarningSalesPriceTooHigh | Integer | Some items include a sales price that is higher than the list price. The sales price has been defaulted to the list price. | |
| ValidationWarningMpnInvalid | Integer | Some items include incorrectly formatted MPNs. | |
| IngestedVideosCount | Integer | The number of videos successfully ingested from the feed file. | |
| NotIngestedVideosCount | Integer | The number of videos that were not ingested from the feed file. | |
| TotalVideosCount | Integer | The number of videos in the feed file. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Returns feeds owned by the user account associated with the operation.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| AdAccountId | = |
| CatalogId | = |
For example:
SELECT * FROM Feeds WHERE Id = '2542622901002'
SELECT * FROM Feeds WHERE AdAccountId = '549768233165'
SELECT * FROM Feeds WHERE CatalogId = '4842503688348'
| Name | Type | References | Description |
| Id [KEY] | String | ID of the feed. | |
| Name | String | A human-friendly name associated to a given feed. | |
| CreatedAt | Datetime | CreatedAt time. | |
| UpdatedAt | Datetime | UpdatedAt time. | |
| CatalogType | String | Type of the catalog entity.
The allowed values are RETAIL, HOTEL, CREATIVE_ASSETS. | |
| Format | String | The file format of a feed.
The allowed values are TSV, CSV, XML. | |
| Location | String | The URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing. | |
| Status | String | Status for catalogs entities. Present in catalogs_feed values. When a feed is deleted,the response will inform DELETED as status.
The allowed values are ACTIVE, INACTIVE. | |
| DefaultCurrency | String | Currency Codes from ISO 4217. | |
| DefaultLocale | String | The locale used within a feed for product descriptions. | |
| DefaultCountry | String | Country ID from ISO 3166-1 alpha-2. | |
| DefaultAvailability | String | Default availability for products in a feed.
The allowed values are IN_STOCK, OUT_OF_STOCK, PREORDER. | |
| CredentialsUsername | String | The required username for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password. | |
| CredentialsPassword | String | The required password for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password. | |
| PreferredProcessingScheduleTime | String | A time in format HH:MM with leading 0 (zero). This field is OPTIONAL. Use this to configure the preferred time for processing a feed. | |
| PreferredProcessingScheduleTimezone | String | The timezone considered for the processing schedule time. This field is OPTIONAL.Use this to configure the preferred time for processing a feed. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. | |
| CatalogId | String | Filter entities for a given catalog_id. If not given, all catalogs are considered. |
Get a list of your followers.
No filters are supported server-side for this table. All criteria are handled client-side within the Cloud.
SELECT * FROM Followers
| Name | Type | References | Description |
| Username [KEY] | String | Username | |
| Type | String | Always user |
Get a list of your followers.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountID | = |
| ExplicitFollowing | = |
| FeedType | = |
For example:
SELECT * FROM Following
SELECT * FROM Following WHERE AdAccountId = '547362621403'
SELECT * FROM Following WHERE FeedType = 'ALL'
SELECT * FROM Following WHERE ExplicitFollowing = true
| Name | Type | References | Description |
| Username [KEY] | String | Username | |
| Type | String | Always user |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| FeedType | String | Specifies the type of followees to be kept when filtering them. Default - ALL
The allowed values are ALL, RANKED, CREATOR_ONLY, RANKED_CREATOR_ONLY. | |
| ExplicitFollowing | Boolean | Whether or not to include implicit user follows, which means followees with board follows. | |
| AdAccountID | String | Unique identifier of an ad account. |
Get a list of the boards a user follows.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountID | = |
| ExplicitFollowing | = |
For example:
SELECT * FROM FollowingBoards
SELECT * FROM FollowingBoards WHERE AdAccountId = '547362621403'
SELECT * FROM FollowingBoards WHERE ExplicitFollowing = true
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the board. | |
| Name | String | The name of the board. | |
| Description | String | The description of the board. | |
| CreatedAt | Datetime | Date and time of board creation. | |
| BoardPinsModifiedAt | Datetime | Date and time of last board pins modified. | |
| CollaboratorCount | Integer | Count of collaborators on the board. | |
| PinCount | Integer | Count of pins on the board. | |
| FollowerCount | Integer | Board follower count. | |
| MediaImageCoverUrl | String | Board cover image. | |
| MediaPinThumbnailUrls | String | Board pin thumbnail urls. | |
| OwnerUsername | String | Owner Username. | |
| Privacy | String | Privacy setting for a board.Default - PUBLIC
The allowed values are PUBLIC, PROTECTED, SECRET. | |
| IsAdsOnly | Boolean | Indicates whether the board is restricted to ad-only Pins. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| ExplicitFollowing | Boolean | Whether or not to include implicit user follows, which means followees with board follows. | |
| AdAccountID | String | Unique identifier of an ad account. |
See a list of labels for assets that your account owns, filtered by different criteria. If no filter is provided, it defaults to labels associated with the ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| Id | =, IN |
| LabelType | =, IN |
| Status | =, IN |
| CampaignIds | =, IN |
For example:
SELECT * FROM Labels WHERE AdAccountId = '549768561505'
SELECT * FROM Labels WHERE AdAccountId = '549768561505' AND LabelType = 'CUSTOM' AND Status = 'ACTIVE'
| Name | Type | References | Description |
| Id [KEY] | String | Label ID. | |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account this label belongs to. |
| Value | String | Label name. 100-character limit. | |
| LabelType | String | Category for the labeled items. Defaults to BRAND server-side when omitted.
The allowed values are BRAND, CUSTOM. | |
| Status | String | Label entity status. Defaults to ACTIVE server-side when omitted.
The allowed values are ACTIVE, ARCHIVED. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CampaignIds | String | List of campaign IDs to use to filter the results. |
Get a list of your linked business accounts.
No filters are supported server-side for this table. All criteria are handled client-side within the Cloud.
SELECT * FROM LinkedBusinesses
| Name | Type | References | Description |
| Username [KEY] | String | A valid username. | |
| ImageSmallUrl | String | Image Small Url. | |
| ImageMediumUrl | String | Image Medium Url. | |
| ImageLargeUrl | String | Image Large Url. | |
| ImageXLargeUrl | String | Image XLarge Url. |
Query local stores for a catalog owned by the operation user account.
The Cloud 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 Cloud. CatalogId is a required column to access this table.
SELECT * FROM LocalStores WHERE CatalogId = '4842503688348'
SELECT * FROM LocalStores WHERE CatalogId = '4842503688348' AND Id = '13123627'
SELECT * FROM LocalStores WHERE CatalogId = '4842503688348' AND Id IN ('13123627', '13123628')
SELECT * FROM LocalStores WHERE CatalogId = '4842503688348' AND AdAccountId = '549755885175'
| Name | Type | References | Description |
| Id [KEY] | String | Unique identifier of the local store. | |
| CatalogId | String |
Catalogs.Id | Unique identifier of the catalog. |
| StoreCode | String | Merchant-provided unique code for the store within the catalog. | |
| Name | String | Store name. | |
| AddressPrimary | String | Primary address line of the store. | |
| AddressSecondary | String | Secondary address line of the store. | |
| City | String | City where the store is located. | |
| Region | String | State or region code where the store is located. | |
| PostalCode | String | Postal or ZIP code of the store. | |
| Country | String | Country code (ISO 3166-1 alpha-2) where the store is located. | |
| Latitude | Double | Geographic latitude coordinate of the store. | |
| Longitude | Double | Geographic longitude coordinate of the store. | |
| CreatedAt | Datetime | Timestamp when the store was created. | |
| UpdatedAt | Datetime | Timestamp when the store was last updated. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
List media uploads owned by the operation user account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| MediaId | = |
For example:
SELECT * FROM MediaUploads
SELECT * FROM MediaUploads WHERE MediaId = '12345'
| Name | Type | References | Description |
| MediaId [KEY] | String | Unique identifier for this media upload. Used to track status and for attaching during Pin creation. | |
| MediaType | String | The type of the media upload.
The allowed values are video. | |
| Status | String | The status of the media upload.
The allowed values are registered, processing, succeeded, failed. |
Get the order lines associated with an ad account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| AdAccountId | = |
For example:
SELECT * FROM OrderLines WHERE AdAccountId = '549768561505'
SELECT * FROM OrderLines WHERE AdAccountId = '549768561505' AND Id = '2680059247422'
| Name | Type | References | Description |
| Id [KEY] | String | Order line ID. | |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account this order line belongs to. |
| Name | String | Order line name. | |
| Status | String | Order line status.
The allowed values are ACTIVE, PAUSED, DELETED. | |
| Type | String | The type of the entity. Always orderline. | |
| Budget | Long | Order line budget in micro currency. | |
| PaidBudget | Long | Order line paid budget in micro currency. | |
| PaidType | String | Order line paid type.
The allowed values are PAID, BONUS, MAKE_GOOD, TEST. | |
| PurchaseOrderId | String | Purchase order ID. | |
| StartTime | Datetime | Start time of the order line. | |
| EndTime | Datetime | End time of the order line. | |
| CampaignIds | String | Associated list of campaign IDs. |
Get analytics for a Pin owned by the operation user account, or on a group board shared with this account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
PinId and MetricTypes are required columns to query this view.
| Column | Supported Operators |
| PinId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| AppTypes | = |
| MetricTypes | = |
| SplitField | = |
| AdAccountId | = |
For example:
SELECT * FROM PinAnalytics WHERE PinId = '813744226420795884' AND MetricTypes = 'VIDEO_MRC_VIEW'
SELECT * FROM PinAnalytics WHERE PinId = '813744226420795884' AND MetricTypes = 'VIDEO_MRC_VIEW' AND StartDate = '2024-01-01' AND EndDate = '2024-03-31'
| Name | Type | References | Description |
| PinId | String |
Pins.Id | The unique identifier of the Pin. |
| Date | Date | Metrics date (UTC): YYYY-MM-DD. | |
| DataStatus | String | Metrics availability status for the date. | |
| Impression | Integer | Total impressions. | |
| OutboundClick | Integer | Total outbound clicks. | |
| PinClick | Integer | Total Pin clicks. | |
| Save | Integer | Total saves. | |
| SaveRate | Decimal | Save rate. | |
| TotalComments | Integer | Total comments. | |
| TotalReactions | Integer | Total reactions. | |
| UserFollow | Integer | Total follows attributed to the Pin. | |
| ProfileVisit | Integer | Total profile visits attributed to the Pin. | |
| VideoMrcView | Integer | Video views (MRC standard). | |
| Video10sView | Integer | Number of times the video was played for at least 10 seconds. | |
| Quartile95PercentView | Integer | Number of times the video was played to 95 percent completion. | |
| VideoV50WatchTime | Decimal | Total play time (V50 watch time). | |
| VideoStart | Integer | Number of times the video started playing. | |
| VideoAvgWatchTime | Decimal | Average video watch time. | |
| StartDate | Date | Metric report start date (UTC). Format: YYYY-MM-DD. | |
| EndDate | Date | Metric report end date (UTC). Format: YYYY-MM-DD. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AppTypes | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| MetricTypes | String | Pin metric types to get data for. Cannot be ALL when SplitField is set to any value other than NO_SPLIT.
The allowed values are ALL, IMPRESSION, OUTBOUND_CLICK, PIN_CLICK, SAVE, SAVE_RATE, TOTAL_COMMENTS, TOTAL_REACTIONS, USER_FOLLOW, PROFILE_VISIT, VIDEO_MRC_VIEW, VIDEO_10S_VIEW, QUARTILE_95_PERCENT_VIEW, VIDEO_V50_WATCH_TIME, VIDEO_START, VIDEO_AVG_WATCH_TIME. | |
| SplitField | String | How to split the data into groups. Not including this param means data won't be split.
The allowed values are NO_SPLIT, APP_TYPE. The default value is NO_SPLIT. | |
| AdAccountId | String | Unique identifier of an ad account, used for Business Access. |
Get a Pin owned by the owned by the User or on a group board that has been shared with this account
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| BoardId | = |
| SectionId | = |
| AdAccountId | = |
For example:
SELECT * FROM Pins WHERE Id = '3457832451'
SELECT * FROM Pins WHERE BoardId = '3457832451'
SELECT * FROM Pins WHERE AdAccountId = '549769357724'
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the Pin. | |
| BoardId | String |
Boards.Id | The unique identifier of the board. |
| SectionId | String | The unique identifier of the section. | |
| AltText | String | The alt text for the Pin's image. | |
| BoardOwnerUsername | String | UserName of the BoardOwner. | |
| CreatedAt | Datetime | The date and time when the Pin was created. | |
| Description | String | Description of the Pin. | |
| Link | String | Link to the Pin. | |
| MediaType | String | MediaType of the Pin.
The allowed values are image, video, multiple_images, multiple_videos, multiple_mixed. | |
| Media | String | Media for the Pin. | |
| Title | String | Title of the Pin. | |
| PinMetrics | String | Pin metrics of the Pin. | |
| IsRemovable | Boolean | Indicates whether the Pin can be removed from a board. | |
| ProductTagsAggregate | String | The array of product tags of the Pin. | |
| CreativeType | String | The creative type of the ad associated with the Pin.
The allowed values are REGULAR, VIDEO, SHOPPING, CAROUSEL, MAX_VIDEO, COLLECTION, IDEA, SHOWCASE, QUIZ, COLLAGE, MAX_WIDTH_REGULAR_COLLECTION, MAX_WIDTH_VIDEO_COLLECTION. | |
| DominantColor | String | The dominant color present in the Pin's image. | |
| IsOwner | Boolean | Indicates whether the authenticated user account is the owner of this Pin. | |
| IsStandard | Boolean | Indicates whether this is a standard Pin. | |
| ParentPinId | String | The ID of the original Pin from which this Pin was saved, if applicable. | |
| HasBeenPromoted | Boolean | Indicates whether the Pin has been promoted. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. When specified, the Pin is returned for the owner of that ad account. Filter only. |
Retrieve demographic information, related pins, and trend lines for specified product categories.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
ProductCategory and Region are required columns to query this view.
| Column | Supported Operators |
| ProductCategory | =, IN |
| Region | = |
| LookbackWindow | = |
| EngagementType | = |
For example:
SELECT * FROM ProductCategoryDetails WHERE ProductCategory = 'DRESSES' AND Region = 'US'
SELECT * FROM ProductCategoryDetails WHERE ProductCategory IN ('DRESSES', 'SHOES') AND Region = 'US' AND LookbackWindow = 90
| Name | Type | References | Description |
| ProductCategory [KEY] | String | The product category. Maps to the product_categories request parameter (up to 20 categories). | |
| Region | String | The geographic region of interest, formatted as ISO 3166-2 country codes delimited by '+' (for example US, GB+IE, CA). | |
| HasPrediction | Boolean | Indicates whether the product category has a prediction available for the next 90 days. | |
| Demographics | String | Demographic distribution for the product category. | |
| MetricsHighlights | String | Highlighted trend metrics for the product category. | |
| RelatedSearches | String | Related search terms for this product category. | |
| TimeSeries | String | Time series data showing trend values over time, indexed between 0 and 100. | |
| PredictedTimeSeries | String | Weekly observations of the predicted relative search volume over the next 3 months. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| LookbackWindow | Integer | Time period for historical data analysis in days.
The allowed values are 90, 180, 365, 730. The default value is 365. | |
| EngagementType | String | Type of engagement metric to analyze.
The allowed values are ENGAGEMENT, OUTBOUND_CLICK, SAVE. The default value is ENGAGEMENT. |
Get targeting analytics for one or more campaign.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| Granularity | = |
| ClickWindowDays | = |
| EngagementWindowDays | = |
| ViewWindowDays | = |
| ProductGroupId | = |
For example:
SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451' AND AdAccountId = '3457832451'
SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451'
SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451' AND AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| AdAccountId | String |
AdAccounts.Id | The unique identifier of the ad account. |
| ProductGroupId | String | The unique identifier of the product group. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | The unique identifier of the advertiser. | |
| AdGroupEntityStatus | Double | The status of the ad group. | |
| AdId | Double | The unique identifier of the ad. | |
| CampaignId | String |
Campaigns.Id | The unique identifier of the campaign. |
| CampaignDailySpendCap | String | The daily spending cap for the campaign, in microcurrency. | |
| CampaignEntityStatus | String | The current entity status of the campaign. | |
| CampaignLifetimeSpendCap | Integer | The lifetime spending cap for the campaign, in microcurrency. | |
| Ctr | Double | The click-through rate (CTR), measured as clicks divided by impressions. | |
| Ctr2 | Double | The organic click-through rate (CTR), measured as clicks divided by organic impressions. | |
| CheckoutRoas | Double | The return on ad spend (ROAS) for checkout conversions. | |
| Clickthrough1 | Integer | The number of paid clickthroughs. | |
| Clickthrough2 | Integer | The number of organic clickthroughs. | |
| Clickthrough1Gross | Integer | The gross number of paid clickthroughs, including invalid clicks. | |
| CpcInMicroDollar | Decimal | The cost per click (CPC), in microdollars. | |
| CpmInMicroDollar | Decimal | The cost per mille (CPM), in microdollars. | |
| Ectr | Decimal | The effective click-through rate (ECTR). | |
| EcpeInDollar | Decimal | The effective cost per engagement (ECPE), in dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | The effective engagement rate. | |
| EcpvInDollar | Decimal | The effective cost per video view (ECPV), in dollars. | |
| EcpcvInDollar | Decimal | The effective cost per completed video view (ECPCV), in dollars. | |
| EcpcvP95InDollar | Decimal | The effective cost per video view at 95 percent completion (ECPCV P95), in dollars. | |
| EcpcInMicroDollar | Decimal | The effective cost per click (ECPC), in microdollars. | |
| EcpmInMicroDollar | Decimal | The effective cost per mille (ECPM), in microdollars. | |
| Engagement1 | Integer | The number of paid engagements. | |
| Engagement2 | Integer | The number of organic engagements. | |
| Impression1 | Integer | The number of paid impressions. | |
| Impression1Gross | Integer | The gross number of paid impressions, including invalid impressions. | |
| Impression2 | Integer | The number of organic impressions. | |
| IdeaPinProductTagVisit1 | Integer | The number of paid visits to a product page via an Idea Pin product tag. | |
| IdeaPinProductTagVisit2 | Integer | The number of organic visits to a product page via an Idea Pin product tag. | |
| InAppCheckoutCostPerAction | Double | The cost per action for in-app checkout conversions. | |
| OutboundClick1 | Integer | The number of paid outbound clicks. | |
| OutboundClick2 | Integer | The number of organic outbound clicks. | |
| PinId | String |
Pins.Id | The unique identifier of the pin. |
| PageVisitCostPerAction | Double | The cost per action for page visit conversions. | |
| PageVisitRoas | Double | The return on ad spend (ROAS) for page visit conversions. | |
| PaidImpression | Integer | The number of paid impressions served. | |
| Repin1 | Integer | The number of paid repins. | |
| Repin2 | Integer | The number of organic repins. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | The total number of paid and organic clickthroughs. | |
| TotalEngagementSignup | Integer | The total number of signup conversions attributed to engagement. | |
| TotalEngagementCheckout | Integer | The total number of checkout conversions attributed to engagement. | |
| TotalClickSignup | Integer | The total number of signup conversions attributed to a click. | |
| TotalClickCheckout | Integer | The total number of checkout conversions attributed to a click. | |
| TotalViewSignup | Integer | The total number of signup conversions attributed to a view. | |
| TotalViewCheckout | Integer | The total number of checkout conversions attributed to a view. | |
| TotalConversions | Integer | The total number of conversions. | |
| TotalEngagementSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to engagement, in microdollars. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to engagement, in microdollars. | |
| TotalClickSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a click, in microdollars. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a click, in microdollars. | |
| TotalViewSignupValueInMicroDollar | Decimal | The total value of signup conversions attributed to a view, in microdollars. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions attributed to a view, in microdollars. | |
| TotalPageVisit | Integer | The total number of page visit conversions. | |
| TotalSignup | Integer | The total number of signup conversions. | |
| TotalCheckout | Integer | The total number of checkout conversions. | |
| TotalSignupValueInMicroDollar | Decimal | The total value of signup conversions, in microdollars. | |
| TotalCheckoutValueInMicroDollar | Decimal | The total value of checkout conversions, in microdollars. | |
| TotalVideo3secViews | Integer | The total number of video views lasting at least 3 seconds. | |
| TotalVideoP100Complete | Integer | The total number of videos viewed to 100 percent completion. | |
| TotalVideoP0Combined | Integer | The total number of video views with any amount of content shown. | |
| TotalVideoP25Combined | Integer | The total number of videos viewed to at least 25 percent completion. | |
| TotalVideoP50Combined | Integer | The total number of videos viewed to at least 50 percent completion. | |
| TotalVideoP75Combined | Integer | The total number of videos viewed to at least 75 percent completion. | |
| TotalVideoP95Combined | Integer | The total number of videos viewed to at least 95 percent completion. | |
| TotalVideoMrcViews | Integer | The total number of video views meeting the MRC (Media Rating Council) viewability standard. | |
| TotalVideoAvgWatchtimeInSecond | Integer | The average video watch time across all video views, in seconds. | |
| TotalRepinRate | Double | The total repin rate across paid and organic. | |
| TotalWebCheckout | Integer | The total number of web checkout conversions. | |
| TotalWebCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions, in microdollars. | |
| TotalWebClickCheckout | Integer | The total number of web checkout conversions attributed to a click. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a click, in microdollars. | |
| TotalWebEngagementCheckout | Integer | The total number of web checkout conversions attributed to engagement. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to engagement, in microdollars. | |
| TotalWebViewCheckout | Integer | The total number of web checkout conversions attributed to a view. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | The total value of web checkout conversions attributed to a view, in microdollars. | |
| Video3secViews2 | Integer | The number of organic video views lasting at least 3 seconds. | |
| VideoLength | Integer | The length of the video, in milliseconds. | |
| VideoMrcViews2 | Integer | The number of organic video views meeting the MRC (Media Rating Council) viewability standard. | |
| VideoP0Combined2 | Integer | The number of organic video views with any amount of content shown. | |
| VideoP100Complete2 | Integer | The number of organic videos viewed to 100 percent completion. | |
| VideoP25Combined2 | Integer | The number of organic videos viewed to at least 25 percent completion. | |
| VideoP50Combined2 | Integer | The number of organic videos viewed to at least 50 percent completion. | |
| VideoP75Combined2 | Integer | The number of organic videos viewed to at least 75 percent completion. | |
| VideoP95Combined2 | Integer | The number of organic videos viewed to at least 95 percent completion. | |
| WebCheckoutCostPerAction | Double | The cost per action for web checkout conversions. | |
| WebCheckoutRoas | Double | The return on ad spend (ROAS) for web checkout conversions. | |
| WebSessions1 | Integer | The number of paid web sessions. | |
| WebSessions2 | Integer | The number of organic web sessions. | |
| CostPerPaidOutboundClickInDollar | Decimal | Average cost per paid outbound click. | |
| PaidOutboundClicksPerImpression | Decimal | Paid outbound clicks divided by paid impressions. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Granularity | String | The time granularity used to aggregate the analytics data.
The allowed values are TOTAL, DAY, WEEK, MONTH. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data 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. | |
| 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 | Integer | 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. | |
| ReportingTimezone | String | The timezone used when reporting analytics data.
The allowed values are PINTEREST_TIME_ZONE, AD_ACCOUNT_TIME_ZONE. |
Get a list of product groups for a given catalog feed owned by the operation user account.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| Id | = |
| CatalogId | = |
| FeedId | = |
| AdAccountId | = |
For example:
SELECT * FROM ProductGroups
SELECT * FROM ProductGroups WHERE Id = '443727193917'
SELECT * FROM ProductGroups WHERE CatalogId = '2680059592705'
SELECT * FROM ProductGroups WHERE FeedId = '2680059592705'
| Name | Type | References | Description |
| Id [KEY] | String | ID of the catalog product group. | |
| CatalogId | String |
Catalogs.Id | Catalog ID pertaining to the product group. |
| CatalogType | String | The catalog type of the product group.
The allowed values are RETAIL, HOTEL, CREATIVE_ASSETS. | |
| FeedId | String |
Feeds.Id | ID of the catalog feed belonging to this catalog product group. |
| Name | String | Name of the catalog product group. | |
| Description | String | Description of the catalog product group. | |
| Country | String | Country associated with the product group. | |
| Locale | String | Locale associated with the product group. | |
| Status | String | Status of the product group.
The allowed values are ACTIVE, INACTIVE. | |
| Type | String | Type of the catalog product group.
The allowed values are MERCHANT_CREATED, ALL_PRODUCTS, BEST_DEALS, PINNER_FAVORITES, TOP_SELLERS, BACK_IN_STOCK, NEW_ARRIVALS, SHOPIFY_COLLECTIONS, I2PC, CATALOG_EXPANSION. | |
| Filters | String | The filters used to define the product group. | |
| CreatedAt | Datetime | The time the catalog product group was created. Unix timestamp in seconds. | |
| UpdatedAt | Datetime | The time the catalog product group was last updated. Unix timestamp in seconds. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account, used for Business Access. |
Gets all promotions associated with an ad account ID that can be applied to an ad group.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM Promotions WHERE AdAccountId='549768561505';
| Name | Type | References | Description |
| Id [KEY] | String | Promotion ID | |
| AdAccountId | String |
AdAccounts.Id | The Ad Account ID that this promotion belongs to |
| ExternalId | String | Platform-specific ID for this promotion. Will be null for promotions first created within Pinterest. | |
| PlatformType | String | The source integration platform used when creating the promotion. Currently supported values are 'DEFAULT' and 'SHOPIFY'.
The allowed values are DEFAULT, SHOPIFY. | |
| PromotionTitle | String | Internal name for the promotion. | |
| PromotionCode | String | Code that can be used to redeem a promotion. | |
| StartTime | Datetime | Promotion start time. Unix timestamp in seconds. Independent of campaign start time. | |
| EndTime | Datetime | Promotion end time. Unix timestamp in seconds. Independent of campaign end time. | |
| PromotionType | String | Determines the displayed promotion text along with what parameters (if any) are needed to complete the template. This list is not finalized, and will be updated as new types are supported
The allowed values are VARIABLE, SITEWIDE, CHECKOUT, SAVE_X_ON_Y, BUY_X_GET_Y, SPEND_X_SAVE_Y, FREE_SHIPPING, FREE_SHIPPING_MINIMUM, FREE_SHIPPING_WITH_DISCOUNT, SITEWIDE_IN_STORES, EXTRA_PERCENT_OFF, GIFT_WITH_PURCHASE, GIFT_WITH_PURCHASE_MINIMUM, FIXED, PERCENT_OFF_CLEARANCE, X_OFF_Y, GIFT_WITH_FIRST_PURCHASE, BUY_X_GET_ONE_FREE, CASH_BACK, POINTS_ON_ALL_PURCHASES, BONUS, POINTS_WITH_PURCHASE. | |
| TemplateValues | String | Numeric value of the specific template. | |
| DiscountStatus | String | Discount status based on the current time and start and end time of discount
The allowed values are OTHER, ACTIVE, PAUSED, SCHEDULED, EXPIRED. | |
| Status | String | Entity status
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| PromotionCustomId | String | An optional user-defined promotion ID for this promotion. Copied from the Pinterest system-generated ID if the user did not provide one. |
Get a list of the age bucket which are available inside the targets.
| Name | Type | References | Description |
| AgeBucketKey | String | It contains the key of the age bucket. | |
| AgeBucketValue | String | It contains the value of the age bucket. |
Get a list of the app type which are available inside the targets.
| Name | Type | References | Description |
| AppKey | String | It contains the key of the apptype. | |
| AppValue | String | It contains the value of the apptype. |
Returns a list of audience exclusion targeting options available for ad targeting.
SELECT * FROM TargetingTypeAudienceExclude
| Name | Type | References | Description |
| AudienceExcludeKey | String | The key identifier for the audience exclusion targeting option. | |
| AudienceExcludeValue | String | The display value for the audience exclusion targeting option. |
Returns a list of audience inclusion targeting options available for ad targeting.
SELECT * FROM TargetingTypeAudienceInclude
| Name | Type | References | Description |
| AudienceIncludeKey | String | The key identifier for the audience inclusion targeting option. | |
| AudienceIncludeValue | String | The display value for the audience inclusion targeting option. |
Get a list of the gender which are available inside the targets.
| Name | Type | References | Description |
| GenderKey | String | It contains the key of the gender. | |
| GenderValue | String | It contains the value of the gender. |
Get a list of the geo which are available inside the targets.
| Name | Type | References | Description |
| GeoKey | String | It contains the key of the Geo. | |
| GeoValue | String | It contains the value of the Geo. |
Get a list of the interest which are available inside the targets.
| Name | Type | References | Description |
| InterestId | String | It contains the id of the interest. | |
| InterestLevel | String | It contains the level of the interest. | |
| InterestName | String | It contains the name of the interest. | |
| InterestAggregate | String | It contains the data inside the particular level of the interest. |
Returns a list of keyword targeting options available for ad targeting.
SELECT * FROM TargetingTypeKeyword
| Name | Type | References | Description |
| KeywordKey | String | The key identifier for the keyword targeting option. | |
| KeywordValue | String | The display value for the keyword targeting option. |
Get a list of the locale which are available inside the targets.
| Name | Type | References | Description |
| LocaleKey | String | It contains the key of the locale | |
| LocaleValue | String | It contains the value of the locale |
Get a list of the location which are available inside the targets.
No filters are supported server-side for this view. All criteria are handled client-side within the Cloud.
For example:
SELECT * FROM TargetingTypeLocations
| Name | Type | References | Description |
| LocationKey | String | It contains the key of the Location | |
| LocationValue | String | It contains the value of the Location |
Get a list of growing shopping product categories in ranked order, with filtering by engagement type, vertical, age, and gender.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
Region is a required column to query this view.
| Column | Supported Operators |
| Region | = |
| EngagementType | = |
| Verticals | =, IN |
| Ages | =, IN |
| Genders | =, IN |
For example:
SELECT * FROM TrendingProductCategories WHERE Region = 'US'
SELECT * FROM TrendingProductCategories WHERE Region = 'US' AND EngagementType = 'SAVE' AND Verticals = 'FASHION'
| Name | Type | References | Description |
| PinterestProductCategoryId [KEY] | Integer | Pinterest product category ID. | |
| Region | String | The geographic region of interest, formatted as ISO 3166-2 country codes delimited by '+' (for example US, GB+IE, CA). | |
| ProductCategory | String | Product category name. | |
| EngagementType | String | Type of engagement metric to analyze.
The allowed values are ENGAGEMENT, OUTBOUND_CLICK, SAVE. The default value is ENGAGEMENT. | |
| PctChangeMom | Decimal | Month-over-month change percentage. | |
| PercentRelativeVolume | Decimal | Relative volume percentage. | |
| Verticals | String | Vertical names associated with the product category.
The allowed values are FASHION, HOME_DECOR, BEAUTY. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| Ages | String | Age buckets to filter by. If not provided, all ages are included.
The allowed values are 18-24, 25-34, 35-44, 45-49, 50-54, 55-64, 65+. | |
| Genders | String | Genders to filter by. If not provided, all genders are included.
The allowed values are MALE, FEMALE, UNSPECIFIED. |
Get account information for the operation User Account
No filters are supported server-side for this view. All criteria are handled client-side within the Cloud.
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the user account. | |
| AccountType | String | The type of the user account. | |
| ProfileImage | String | The URL of the user's profile image. | |
| Username | String | The username of the user account. | |
| About | String | A short description or bio displayed on the user's profile. | |
| WebsiteURL | String | The URL of the user's website. | |
| BoardCount | Integer | The number of boards owned by the user. | |
| PinCount | Integer | The number of pins created by the user. | |
| FollowerCount | Integer | The number of users following this account. | |
| FollowingCount | Integer | The number of accounts this user follows. | |
| BusinessName | String | The name of the business associated with the user account. | |
| MonthlyViews | Integer | The total number of monthly views on the user account's profile. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountID | String | Specify an ad_account_id to use the owner of that ad_account as the operation user_account. |
Get Daily Metric of User Account
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| FromClaimedContent | = |
| PinFormat | = |
| AppTypes | = |
| MetricTypes | = |
| SplitFields | = |
| AdAccountID | = |
For example:
SELECT * FROM UserAccountDailyMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountDailyMetrics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| OutboundClick | Integer | Total outbound click. | |
| OutboundClickRate | Decimal | Outbound Click Rate. | |
| Engagement | Integer | Total engagements. | |
| EngagementRate | Decimal | Engagement Rate. | |
| PinClick | Integer | Total pin clicks. | |
| PinClickRate | Decimal | Pin Click Rate. | |
| Impression | Integer | Total impressions. | |
| Save | Integer | Total saves. | |
| SaveRate | Decimal | Save Rate. | |
| DataStatus | String | Metrics Availablity. | |
| Date | Date | Metrics Date. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. | |
| PinFormat | String | Pin formats to get data for, default is all.
The allowed values are ALL, ORGANIC_IMAGE, ORGANIC_PRODUCT, ORGANIC_VIDEO, ADS_STANDARD, ADS_PRODUCT, ADS_VIDEO, ADS_IDEA. The default value is ALL. | |
| AppTypes | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| MetricTypes | String | Metric types to get data for, default is all.
The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL. The default value is ALL. | |
| SplitField | String | How to split the data into groups. Not including this param means data won't be split.
The allowed values are NO_SPLIT, APP_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT. The default value is NO_SPLIT. | |
| AdAccountID | String | Unique identifier of an ad account. |
Get Summary Metric of User Account
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| FromClaimedContent | = |
| PinFormat | = |
| AppTypes | = |
| MetricTypes | = |
| SplitFields | = |
| AdAccountID | = |
For example:
SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountSummaryMetrics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| OutboundClick | Integer | Total outbound click. | |
| OutboundClickRate | Decimal | Outbound Click Rate. | |
| Engagement | Integer | Total engagements. | |
| EngagementRate | Decimal | Engagement Rate. | |
| PinClick | Integer | Total pin clicks. | |
| PinClickRate | Decimal | Pin Click Rate. | |
| Impression | Integer | Total impressions. | |
| Save | Integer | Total saves. | |
| SaveRate | Decimal | Save Rate. | |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. | |
| PinFormat | String | Pin formats to get data for, default is all.
The allowed values are ALL, ORGANIC_IMAGE, ORGANIC_PRODUCT, ORGANIC_VIDEO, ADS_STANDARD, ADS_PRODUCT, ADS_VIDEO, ADS_IDEA. The default value is ALL. | |
| AppTypes | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| MetricTypes | String | Metric types to get data for, default is all.
The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL. The default value is ALL. | |
| SplitField | String | How to split the data into groups. Not including this param means data won't be split.
The allowed values are NO_SPLIT, APP_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT. The default value is NO_SPLIT. | |
| AdAccountID | String | Unique identifier of an ad account. |
Get analytics data about a user's top pins.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| SortBy | = |
| CreatedInLastNDays | = |
| NumOfPins | = |
| MetricTypes | = |
| AppType | = |
| PiFormat | = |
| FromClaimedContent | = |
For example:
SELECT * FROM UserAccountTopVideoPinAnalytics WHERE SortBy = 'IMPRESSION'
SELECT * FROM UserAccountTopVideoPinAnalytics WHERE AppType = 'ALL'
SELECT * FROM UserAccountTopVideoPinAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Impression | Integer | Impression. | |
| Save | Integer | Save. | |
| VideoMrcView | Integer | Video second Views. | |
| VideoAvgWatchTime | Integer | Video second Views. | |
| VideoV50WatchTime | Integer | Video 50 Seond Views. | |
| Quartile95PercentView | Integer | Video 95 percent Views. | |
| Video10SView | Integer | Video 10 second Views. | |
| VideoStart | Integer | VIDEO_START. | |
| OutboundClick | Integer | Outboundclick. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CreatedInLastNDays | Integer | Get metrics for pins created in the last | |
| NumOfPins | Integer | Number of pins to include, default is 10. Max is 50. | |
| MetricTypes | String | Metric types to get data for, default is all.
The allowed values are IMPRESSION, OUTBOUND_CLICK, SAVE, VIDEO_MRC_VIEW, VIDEO_AVG_WATCH_TIME, VIDEO_V50_WATCH_TIME, QUARTILE_95_PERCENT_VIEW, VIDEO_10S_VIEW, VIDEO_START. | |
| AppType | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| PinFormat | String | Pin formats to get data for, default is all.
The allowed values are ALL, ORGANIC_IMAGE, ORGANIC_PRODUCT, ORGANIC_VIDEO, ADS_STANDARD, ADS_PRODUCT, ADS_VIDEO, ADS_IDEA. The default value is ALL. | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. |
Get analytics data about a user's top pins.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| StartDate | =, >, >= |
| EndDate | =, <, <= |
| SortBy | = |
| CreatedInLastNDays | = |
| NumOfPins | = |
| MetricTypes | = |
| AppType | = |
| PiFormat | = |
| FromClaimedContent | = |
For example:
SELECT * FROM UserTopPinAnalytics WHERE SortBy = 'IMPRESSION'
SELECT * FROM UserTopPinAnalytics WHERE AppType = 'ALL'
SELECT * FROM UserTopPinAnalytics WHERE AdAccountId = '3457832451' AND StartDate >= '2024-01-06' AND EndDate <= '2024-04-05'
| Name | Type | References | Description |
| StartDate | Date | Metric report start date. | |
| EndDate | Date | Metric report end date. | |
| Engagement | Integer | Engagement. | |
| EngagementRate | Double | The engagement rate. | |
| Impression | Integer | Impression. | |
| OutboundClick | Integer | Outboundclick. | |
| OutboundClickRate | Integer | OUTBOUNDCLICKRATE. | |
| PinClick | Integer | PINCLICK. | |
| PinClickRate | Integer | PINCLICKRate. | |
| Save | Integer | Save. | |
| SaveRate | Integer | SAVE RATE. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| CreatedInLastNDays | Integer | Get metrics for pins created in the last | |
| NumOfPins | Integer | Number of pins to include, default is 10. Max is 50. | |
| MetricTypes | String | Metric types to get data for, default is all.
The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE. | |
| AppType | String | Apps or devices to get data for, default is all.
The allowed values are ALL, MOBILE, TABLET, WEB. The default value is ALL. | |
| PinFormat | String | Pin formats to get data for, default is all.
The allowed values are ALL, ORGANIC_IMAGE, ORGANIC_PRODUCT, ORGANIC_VIDEO, ADS_STANDARD, ADS_PRODUCT, ADS_VIDEO, ADS_IDEA. The default value is ALL. | |
| FromClaimedContent | String | Filter on Pins that match your claimed domain.
The allowed values are OTHER, CLAIMED, BOTH. The default value is BOTH. |
Get verification code for user to install on the website to claim it.
The Cloud uses the Pinterest API to process WHERE clause conditions built with the following columns and operators. Any remaining filters are processed client-side within the Cloud.
| Column | Supported Operators |
| AdAccountId | = |
For example:
SELECT * FROM UserVerificationCodeForWebsiteClaim WHERE AdAccountId = '549769357724'
| Name | Type | References | Description |
| VerificationCode | String | Code to check against the user claiming the website. | |
| DnsTxtRecord | String | DNS TXT record to check against for the website to be claimed. | |
| Metatag | String | Metatag the verification process searchs for the website to be claimed. | |
| Filename | String | File expected to find on the website being claimed. | |
| FileContent | String | A full html file to upload to the website in order for it to be claimed. |
Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. When specified, the owner of that ad account is used as the operation user account. Filter only. |
Get user websites, claimed or not.
No filters are supported server-side for this table. All criteria are handled client-side within the Cloud.
SELECT * FROM UserWebsites
| Name | Type | References | Description |
| Website | String | Website with path or domain only | |
| Status | String | Status of the verification process. | |
| VerifiedAt | Datetime | UTC timestamp when the verification happened - sometimes missing. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Pinterest.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Pinterest, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateAdPreviewFromImage | Create an ad preview given an ad account ID and the URL of an image to be used to create the Pin and the ad. |
| CreateAdPreviewFromPin | Create an ad preview using an existing Pin, given an ad account ID and a Pin ID. |
| CreateAdPreviewShopping | Create a shopping ad preview given an ad account ID, catalog product group ID, and creative type. |
| CreateCustomerListUpload | Create a customer list upload request for multipart S3 upload. Each part must be at least 5 MB; the last part can be any size greater than 0. |
| GetLocalInventoryItems | Get local inventory items for a catalog. Provide an array of item_id and store_code pairs to identify items. Up to 1000 items per request. |
| RunCustomerListUpload | Start processing a customer list upload. Returns the updated upload metadata once processing has begun. |
| SavePin | Save a Pin to a board or board section owned by the operation user account. |
| VerifyWebsite | Verify a website as a signed-in user. |
Create an ad preview given an ad account ID and the URL of an image to be used to create the Pin and the ad.
Pinterest allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison.
The CreateAdPreviewFromImage stored procedure requires AdAccountId, ImageUrl and Title to be specified.
For example:
EXEC CreateAdPreviewFromImage AdAccountId = '549769357724', ImageUrl = 'https://somewebsite.com/someimage.jpg', Title = 'Testing'
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| ImageUrl | String | True | Image URL. |
| Title | String | True | Title displayed below ad. |
| PromotionId | String | False | Promotion id for the ad to preview, optional and only applicable when creating ad preview for an existing promotion. |
| Name | Type | Description |
| Status | String | Returns the execution status of the stored procedure. |
| Url | String | Preview URL, expires in 7 days. |
Create an ad preview using an existing Pin, given an ad account ID and a Pin ID.
Pinterest allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison.
The CreateAdPreviewFromPin stored procedure requires AdAccountId and PinId to be specified.
For example:
EXEC CreateAdPreviewFromPin AdAccountId = '549769357724', PinId = '7389479023'
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| PinId | String | True | Pin ID. |
| CreativeType | String | False | Creative type of the ad preview.
The allowed values are SHOPPING, COLLECTION, MAX_VIDEO, MAX_WIDTH_VIDEO_COLLECTION, MAX_WIDTH_REGULAR_COLLECTION, CTV_VIDEO. |
| Name | Type | Description |
| Status | String | Returns the execution status of the stored procedure. |
| Url | String | Preview URL, expires in 7 days. |
Create a shopping ad preview given an ad account ID, catalog product group ID, and creative type.
Pinterest allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison.
The CreateAdPreviewShopping stored procedure requires AdAccountId, CatalogProductGroupId and CreativeType to be specified.
For example:
EXEC CreateAdPreviewShopping AdAccountId = '549769357724', CatalogProductGroupId = '2614055967136', CreativeType = 'SHOPPING'
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| CatalogProductGroupId | String | True | Catalog Product Group Id. |
| CreativeType | String | True | Ad format of the shopping ad preview.
The allowed values are SHOPPING, COLLECTION, CAROUSEL, MAX_WIDTH_COLLECTION. |
| CustomizableCtaType | String | False | Select a call to action (CTA) to display below your ad. Available only for ads with direct links enabled.
The allowed values are GET_OFFER, LEARN_MORE, ORDER_NOW, SHOP_NOW, SIGN_UP, SUBSCRIBE, BUY_NOW, CONTACT_US, GET_QUOTE, VISIT_SITE, APPLY_NOW, BOOK_NOW, REQUEST_DEMO, REGISTER_NOW, FIND_A_DEALER, ADD_TO_CART, WATCH_NOW, READ_MORE, BUY_TICKETS, DONATE_NOW, DOWNLOAD, EXPLORE_MORE, FIND_A_LOCATION, FIND_RETAILERS, GET_DEAL, GET_RECIPE, GET_SHOWTIMES, ON_SALE, PLAY_GAME, TRY_IT, TAKE_A_PEEK. |
| HeroImageTitle | String | False | Title displayed below ad. |
| HeroImageUrl | String | False | Hero image URL. |
| HeroPinId | String | False | Pin id for the hero image. When creative type is COLLECTION, either hero_pin_id or (hero_image_url, hero_image_title) is required. |
| ImageTag | String | False | Multi image template tag. |
| ItemId | String | False | Item id for product to preview standard shopping ads, optional and only applicable when creative type is SHOPPING. |
| PreferredMediaType | String | False | Preferred media type.
The allowed values are VIDEO, IMAGE. |
| VideoTag | String | False | Multi video template tag, image_tag and video_tag are mutual exclusive. |
| ShowPromotion | Boolean | False | Include promotion data in preview when available on catalog item. Defaults to false. |
| Name | Type | Description |
| Status | String | Returns the execution status of the stored procedure. |
| Url | String | Preview URL, expires in 7 days. |
Create a customer list upload request for multipart S3 upload. Each part must be at least 5 MB; the last part can be any size greater than 0.
The CreateCustomerListUpload stored procedure creates a customer list upload request for multipart S3 upload. AdAccountId, CustomerListId, Operation, and TotalParts are required parameters.
EXEC CreateCustomerListUpload @AdAccountId = '549755885175', @CustomerListId = '2542620905475', @Operation = 'ADD', @TotalParts = '1'
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| CustomerListId | String | True | Unique identifier of the customer list. |
| Operation | String | True | Operation type for the upload.
The allowed values are ADD, REMOVE. |
| TotalParts | Integer | True | Number of parts to upload the file in. Each part must be at least 5 MB. Maximum 10. |
| Name | Type | Description |
| Id | String | Unique identifier of the created customer list upload. |
| Status | String | Status of the verification process. |
Get local inventory items for a catalog. Provide an array of item_id and store_code pairs to identify items. Up to 1000 items per request.
The GetLocalInventoryItems stored procedure retrieves local inventory items for a catalog. CatalogId, ItemId, and StoreCode are required parameters.
EXEC GetLocalInventoryItems @CatalogId = '4842503688348', @ItemId = 'DS0294-M', @StoreCode = 'STORE-001' EXEC GetLocalInventoryItems @CatalogId = '4842503688348', @ItemId = 'DS0294-M', @StoreCode = 'STORE-001', @AdAccountId = '549755885175'
| Name | Type | Required | Description |
| CatalogId | String | True | Unique identifier of the catalog. |
| ItemId | String | True | Item identifier to filter local inventory items. |
| StoreCode | String | True | Store code to filter local inventory items. |
| AdAccountId | String | False | Unique identifier of an ad account. |
| Name | Type | Description |
| ItemId | String | Item identifier. |
| Status | String | Status of the verification process. |
Start processing a customer list upload. Returns the updated upload metadata once processing has begun.
The RunCustomerListUpload stored procedure starts processing a customer list upload. AdAccountId, CustomerListId, and CustomerListUploadId are required parameters.
EXEC RunCustomerListUpload @AdAccountId = '549755885175', @CustomerListId = '2542620905475', @CustomerListUploadId = '2680059592705'
| Name | Type | Required | Description |
| AdAccountId | String | True | Unique identifier of an ad account. |
| CustomerListId | String | True | Unique identifier of the customer list. |
| CustomerListUploadId | String | True | Unique identifier of the customer list upload. |
| Name | Type | Description |
| Id | String | Unique identifier of the customer list upload. |
| Status | String | Status of the verification process. |
Save a Pin to a board or board section owned by the operation user account.
Pinterest allows only a small subset of columns to be used in the EXECUTE query. These columns can typically only be used with the = comparison.
The SavePin stored procedure requires either BoardId or BoardSectionId to be specified.
For example:
EXEC SavePin PinId = '1059120037385941751', BoardId = '443727193917' EXEC SavePin PinId = '1059120037385941751', BoardSectionId = '555626793714'
| Name | Type | Required | Description |
| PinId | String | True | Unique identifier of a Pin. |
| AdAccountId | String | False | Unique identifier of an ad account. |
| BoardId | String | False | Unique identifier of the board to which the pin will be saved. |
| BoardSectionId | String | False | Unique identifier of the board section to which the pin will be saved. |
| Name | Type | Description |
| Status | String | Returns the execution status of the stored procedure. |
Verify a website as a signed-in user.
To execute this procedure, enter:
EXEC VerifyWebsite @Website = 'pintest-website-12345678.test/test_2', @VerificationMethod = FILENAME
| Name | Type | Required | Description |
| Website | String | True | Website. |
| VerificationMethod | String | False | Verification Method. Default:METATAG
The allowed values are FILENAME, METATAG, DNSTXT. |
| AdAccountID | String | False | Unique identifier of an ad account. |
| Name | Type | Description |
| Status | String | Status of the verification process. |
| Website | String | Website with path or domain only. |
| VerifiedAt | Datetime | UTC timestamp when the verification happened - sometimes missing. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Pinterest:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
| IsInsertable | Boolean | Whether the table can be inserted into. |
| IsDeleteable | Boolean | Whether rows can be deleted from the table. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the AdAccounts table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName = 'AdAccounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
| ColumnCapabilities | Int32 | A bit mask denoting the column's write capabilities. The value is the sum of the following: 1 if the column is required for INSERTs, 2 if the column is allowed for INSERTs, and 4 if the column is allowed for UPDATEs. A value of 0 indicates that the write capabilities of the column are unknown or that the column is read-only. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Pinterest procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the AdAccounts table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAccounts'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AdAccountId | Unique identifier of an Ad Account. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Pinterest. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AdAccountId | Unique identifier of an Ad Account. |
Unique identifier of an Ad Account.
string
""
Driver will use this Account where required. If not fed, it will pick the first Ad Account configured for the Account.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies the scope of the authenticating user's access to the application, to ensure they get appropriate access to data. If a custom OAuth application is needed, this is generally specified at the time the application is created.
string
""
Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.
When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.
When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Pinterest. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the maximum number of records per page the provider returns when requesting data from Pinterest.
int
250
When processing a query, instead of requesting all of the queried data at once from Pinterest, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.