The CData Sync App provides a straightforward way to continuously pipeline your Pinterest data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Pinterest connector can be used from the CData Sync application to pull data from Pinterest and move it to any of the supported destinations.
The Sync App leverages the Pinterest API to enable bidirectional access to Pinterest.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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 Sync App 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.
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 |
| 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. |
| AdsTargetingAnalytics | Get targeting analytics for one or more ads. |
| 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 | Get list of audiences for the ad account. |
| Boards | Get a list of the boards owned by the User |
| BoardSections | Get a list of the boards owned by the User |
| 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. |
| CustomerLists | Get a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience. |
| 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. |
| FollowingInterests | Get a list of a user's following interests in one place. |
| LinkedBusinesses | Get a list of your linked business accounts. |
| Pins | Get a Pin owned by the owned by the User or on a group board that has been shared with this account |
| ProductGroupAnalytics | Get targeting analytics for one or more campaign. |
| 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 | Get a list of the interest which are available inside the targets. |
| TargetingTypeAudienceInclude | Get a list of the interest which are available inside the targets. |
| 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 | Get a list of the interest which are available inside the targets. |
| 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. |
| 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 Sync App 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 Sync App.
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 | 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 | Granularity
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION. The default value is TIME_OF_AD_ACTION. |
Get the ad account analytics report
The Sync App 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 Sync App.
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, HOUR, 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| 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. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| 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 Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| IncludeSharedAccounts | Boolean | Include shared ad accounts |
Get targeting analytics for an ad account.
The Sync App 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 Sync App.
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 | Id of the ad group. |
| TargetingType | 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. | |
| TargetingValues | String | Targeting type value. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | Id of the advertiser. | |
| AdGroupEntityStatus | Double | Id of the advertiser. | |
| AdId | Double | Id of the advertiser. | |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignDailySpendCap | String | Campaign daily spend cap. | |
| CampaignEntityStatus | String | Campaign entity status. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Ctr | Double | Ctr. | |
| Ctr2 | Double | Ctr2. | |
| CheckoutRoas | Double | Checkout roas. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| Ectr | Decimal | Ectr. | |
| EcpeInDollar | Decimal | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| EcpvInDollar | Decimal | Ecpv in dollars. | |
| EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
| EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| Impression2 | Integer | Impression2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| 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 | Decimal | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Decimal | 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 | Decimal | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
| Video3secViews2 | Integer | Video 3 second Views. | |
| VideoLength | Integer | VideoLength. | |
| VideoMrcViews2 | Integer | Video 2 second Views. | |
| 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 | Web checkout roas. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity.
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | 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. |
Get analytics for the ads in the specified AdAccountId
The Sync App 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 Sync App.
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 | Id of the ad |
| AdAccountId | String |
AdAccounts.Id | Id of the ad account |
| Date | Date | Current metrics date. Only returned when granularity is a time-based value. | |
| CampaignEntityStatus | String | Status of the campaign. | |
| AdGroupEntityStatus | String | Status of the ad group. | |
| SpendInDollar | Double | Total spend in dollars. | |
| EcpcInDollar | Double | Ecpc in dollars. | |
| Ctr | Double | Ctr. | |
| Ectr | Double | Ectr. | |
| EcpeInDollar | Double | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| RepinRate | Double | The repin rate. | |
| Ctr2 | Double | Ctr2 | |
| CpmInDollar | Double | Cpm in Dollars. | |
| WebCheckoutCostPerAction | Double | Web checkout cost per action. | |
| WebCheckoutRoas | Double | Web checkout roas | |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| CheckoutRoas | Double | Checkout roas. | |
| Video3secViews2 | Integer | Videos with at least 3 seconds of viewing. | |
| VideoP100Complete2 | Integer | Videos 100 percent complete | |
| VideoP0Combined2 | Integer | Videos 0 percent combined viewed. | |
| VideoP25Combined2 | Integer | Videos 25 percent combined viewed. | |
| VideoP50Combined2 | Integer | Video 50 percent combined viewed. | |
| VideoP75Combined2 | Integer | Video 75 percent combined viewed. | |
| VideoP95Combined2 | Integer | Video 95 percent combined viewed. | |
| VideoMrcViews2 | Integer | Video Mrc Views. | |
| EcpvInDollar | Double | Ecpv in dollars. | |
| EcpcvInDollar | Double | E Cpcv in Dollars | |
| EcpcvP95InDollar | Double | E Cpcv 95 percent in Dollars. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| TotalImpressionFrequency | Double | Total Impression Frequency. | |
| TotalEngagementSignup | Integer | Total Engagement Signup. | |
| TotalEngagementCheckout | Integer | Total Engagement Checkout. | |
| TotalClickSignup | Integer | Total Click Signup. | |
| TotalClickCheckout | Integer | Total Click Checkout. | |
| TotalViewSignup | Integer | Total View Signup. | |
| TotalViewCheckout | Integer | Total View Checkout. | |
| TotalConversions | Integer | Total Conversions. | |
| TotalEngagementSignupValueInMicroDollar | Double | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Double | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Double | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Double | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Double | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Double | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Double | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Double | Total Checkout Value In Micro Dollar. | |
| TotalVideo3secViews | Integer | Total Video 3 second Views. | |
| TotalVideoP100Complete | Integer | Total Video 100 percent Complete. | |
| TotalVideoP0Combined | Integer | Total Video 0 percent Combined. | |
| TotalVideoP25Combined | Integer | Total Video 25 percent Combined. | |
| TotalVideoP50Combined | Integer | Total Video 50 percent Combined. | |
| TotalVideoP75Combined | Integer | Total Video 75 percent Combined. | |
| TotalVideoP95Combined | Integer | Total Video 95 percent Combined. | |
| TotalVideoMrcViews | Integer | Total Video Mrc Views. | |
| TotalVideoAvgWatchtimeInSecond | Integer | Total Video Avg Watchtime In Seconds. | |
| TotalRepinRate | Double | Total Repin Rate. | |
| TotalWebCheckout | Integer | Total Web Checkout. | |
| TotalWebCheckoutValueInMicroDollar | Double | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Double | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Double | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Double | Total Web View Checkout Value In Micro Dollar. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| AdvertiserId | String | Id of the ad account | |
| AdGroupId | String |
AdGroups.Id | Id of the ad group. |
| CampaignDailySpendCap | Integer | Campaign daily spend cap. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| CampaignName | String | Name of the Campaign | |
| Clickthrough2 | Integer | Clickthrough2. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| Impression2 | Integer | Impression2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PaidImpression | Integer | PaidImpression. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| SpendInMicroDollar | Decimal | Total spend in dollars. | |
| TotalClickAddToCart | Integer | Total click add to cart. | |
| TotalClickLead | Integer | Total click lead. | |
| TotalCustom | Integer | Total custom. | |
| TotalEngagement | Integer | Total Engagement. | |
| TotalEngagementLead | Integer | Total Engagement Lead. | |
| TotalIdeaPinProductTagVisit | Integer | Total Idea Pin Product Tag Visit. | |
| TotalImpressionUser | Integer | Total Impression User. | |
| TotalLead | Integer | Total Lead. | |
| TotalOfflineCheckout | Integer | Total offline checkout. | |
| TotalViewAddToCart | Integer | Total view add to cart. | |
| TotalViewLead | Integer | Total view Lead. | |
| TotalWebSessions | Integer | Total web sessions. | |
| VideoLength | Integer | VideoLength. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION. The default value is TIME_OF_AD_ACTION. |
Get analytics for the specified campaigns in the specified AdAccountId
| Name | Type | References | Description |
| CampaignId | String |
Campaigns.Id | Id of the campaign. |
| AdAccountId | String |
AdAccounts.Id | Id of the ad account. |
| Date | Date | Date the analytics row covers. | |
| 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. |
| CampaignBudgetOptimization | Boolean | Clickthrough1 Gross. | |
| AdGroupBudgetInLocalCurrency | String | Ad group budget in local currency. | |
| AdGroupBudgetType | String | Ad group budget type.
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 | Granularity
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | String | The date by which the conversion metrics returned from this endpoint will be reported.
The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION. The default value is TIME_OF_AD_ACTION. |
Get analytics for the ad groups in the specified AdAccountId
The Sync App 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 Sync App.
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 | Id of the ad group. |
| AdAccountId | String |
AdAccounts.Id | Id of the ad account. |
| Date | Date | Date the analytics row covers. | |
| 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. | |
| Impression2 | Integer | Impression2. | |
| TotalImpressionUser | Integer | Total ImpressionUser. | |
| CampaignDailySpendCap | Integer | Campaign Daily Spend Cap. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| CpcInMicroDollar | Double | Cpc In MicroDollar. | |
| CpmInMicroDollar | Double | Cpm In MicroDollar. | |
| EcpcInMicroDollar | Double | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Double | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| SpendInMicroDollar | Double | Spend In MicroDollar. | |
| TotalClickAddToCart | Integer | Total Click Add To Cart. | |
| TotalClickLead | Integer | Total ClickLead. | |
| TotalCustom | Integer | Total Custom. | |
| TotalEngagement | Integer | Total Engagement. | |
| TotalEngagementLead | Integer | Total Engagement Lead. | |
| TotalIdeaPinProductTagVisit | Integer | Total Idea Pin Product Tag Visit. | |
| TotalLead | Integer | Total Lead. | |
| TotalOfflineCheckout | Integer | Total Offline Checkout. | |
| TotalViewAddToCart | Integer | Total View Add To Cart. | |
| TotalViewLead | Integer | Total View Lead. | |
| TotalWebSessions | Integer | Total Web Sessions. | |
| VideoLength | Integer | VideoLength. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| AdId | String |
Ads.Id | Id of the Ad. |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignBudgetOptimization | Boolean | Clickthrough1 Gross. | |
| AdGroupBudgetInLocalCurrency | String | Ad group budget in local currency. | |
| AdGroupBudgetType | String | Ad group budget type.
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 | Granularity
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | 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. |
Get a list of the ad_accounts that the User has access to.
The Sync App 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 Sync App.
SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'
| Name | Type | References | Description |
| Id [KEY] | String | Advertiser ID. | |
| AdAccountId | String |
AdAccounts.Id | Ad Account ID. |
| 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 | Budget type
The allowed values are DAILY, LIFETIME, CBO_ADGROUP. | |
| ConversionLearningModeType | String | oCPM learn mode
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 | PacingDeliveryType
The allowed values are STANDARD, ACCELERATED. | |
| PlacementGroup | String | PlacementGroup | |
| 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 | Third-party tracking URLs. | |
| TrackingUrlsBuyableButton | String | Third-party tracking URLs. | |
| TrackingUrlsClick | String | Third-party tracking URLs. | |
| TrackingUrlsEngagement | String | Third-party tracking URLs. | |
| TrackingUrlsImpression | String | Third-party tracking URLs. | |
| 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| TranslateInterestsToNames | Boolean | Return interests as text names and not topic IDs? |
Get targeting analytics for one or more ad groups.
The Sync App 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 Sync App.
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 | Unique identifier of an ad account. |
| AdGroupId | String |
AdGroups.Id | Id of the ad group. |
| TargetingType | String | Targeting type.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION. | |
| TargetingValues | String | Targeting type value. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | Id of the advertiser. | |
| AdGroupEntityStatus | Double | Id of the advertiser. | |
| AdId | Double | Id of the advertiser. | |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignDailySpendCap | String | Campaign daily spend cap. | |
| CampaignEntityStatus | String | Campaign entity status. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Ctr | Double | Ctr. | |
| Ctr2 | Double | Ctr2. | |
| CheckoutRoas | Double | Checkout roas. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| Ectr | Decimal | Ectr. | |
| EcpeInDollar | Decimal | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| EcpvInDollar | Decimal | Ecpv in dollars. | |
| EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
| EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| Impression2 | Integer | Impression2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| 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 | Decimal | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Decimal | 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 | Decimal | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
| Video3secViews2 | Integer | Video 3 second Views. | |
| VideoLength | Integer | VideoLength. | |
| VideoMrcViews2 | Integer | Video 2 second Views. | |
| 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 | Web checkout roas. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity.
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement 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. |
Get a list of the ad_accounts that the User has access to.
The Sync App 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 Sync App.
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 | Ad creative type
The allowed values are REGULAR, VIDEO, SHOPPING, CAROUSEL, MAX_VIDEO, SHOP_THE_PIN, COLLECTION, IDEA, SHOWCASE, QUIZ. | |
| DestinationUrl | String | Destination URL. | |
| IosDeepLink | String | Deep link URL for iOS devices. | |
| IsPinDeleted | Boolean | Is original pin deleted? | |
| IsRemovable | Boolean | Is pin repinnable? | |
| Name | String | Name of the ad. | |
| PinId | String | Pin ID. | |
| RejectedReasons | String | Reason why the pin was rejected. | |
| RejectionLabels | String | Text reason why the pin was rejected. | |
| ReviewStatus | String | Ad review status
The allowed values are OTHER, PENDING, REJECTED, APPROVED. | |
| Status | String | Entity status
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 | Tracking Urls Audience Verification. | |
| TrackingUrlsBuyableButton | String | Tracking Urls Buyable Button. | |
| TrackingUrlsClick | String | Tracking Urls Click. | |
| TrackingUrlsEngagement | String | Tracking Urls Engagement. | |
| TrackingUrlsImpression | String | Tracking Urls Impression. | |
| Type | String | Type of ad. | |
| UpdatedTime | Datetime | Last update time. | |
| ViewTrackingUrl | String | Tracking URL for ad impressions. |
Get targeting analytics for one or more ads.
The Sync App 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 Sync App.
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 | Unique identifier of an ad account. |
| AdId | String |
Ads.Id | Id of the ad |
| TargetingType | String | Targeting type.
The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION. | |
| TargetingValues | String | Targeting type value. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | Id of the advertiser. | |
| AdGroupEntityStatus | Double | Id of the advertiser. | |
| MetricsAdId | String |
Ads.Id | Id of the ad |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignDailySpendCap | String | Campaign daily spend cap. | |
| CampaignEntityStatus | String | Campaign entity status. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Ctr | Double | Ctr. | |
| Ctr2 | Double | Ctr2. | |
| CheckoutRoas | Double | Checkout roas. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| Ectr | Decimal | Ectr. | |
| EcpeInDollar | Decimal | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| EcpvInDollar | Decimal | Ecpv in dollars. | |
| EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
| EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| Impression2 | Integer | Impression2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| 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 | Decimal | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Decimal | 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 | Decimal | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
| Video3secViews2 | Integer | Video 3 second Views. | |
| VideoLength | Integer | VideoLength. | |
| VideoMrcViews2 | Integer | Video 2 second Views. | |
| 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 | Web checkout roas. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity.
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | 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. |
Get Audience Insights for an ad account.
The Sync App uses 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App uses 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 Sync App.
Select * from AudienceInsightsScopeAndType Select * from AudienceInsightsScopeAndType where AdAccountId = '547362621403'
| Name | Type | References | Description |
| Date | Datetime | Generation date. | |
| Type | String | Type. | |
| Scope | String | Scope. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AdAccountID | String | Unique identifier of an ad account. |
Get list of audiences for the ad account.
The Sync App 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 Sync App.
SELECT * FROM Audiences WHERE Id = '2542622901002' SELECT * FROM Audiences WHERE AdAccountId = '549768233165'
| Name | Type | References | Description |
| Id [KEY] | String | Audience ID. | |
| AdAccountId | String |
AdAccounts.Id | Ad account ID. |
| Name | String | Audience name. | |
| AudienceType | String | Audience Types.
The allowed values are ACTALIKE, ENGAGEMENT, CUSTOMER_LIST, VISITOR. | |
| Description | String | Audience description. | |
| RuleCountry | String | Valid countries include: US,CA, and GB.
The allowed values are US, CA, GB. | |
| RuleCustomerListId | String | Customer list ID. For CUSTOMER_LIST audience_type. | |
| RuleEngagementDomain | String | Engagement domain. | |
| RuleEngagementType | String | Engagement type enum. Optional for ENGAGEMENT audience_type.
The allowed values are click, save, closeup, comment, like. | |
| RuleEvent | String | A Pinterest tag event. Optional for VISITOR audience_type.
The allowed values are pagevisit, signup, checkout, viewcategory, search, addtocart, watchvideo, lead, custom. | |
| RuleEventDataCurrency | String | Currency Codes from ISO 4217. | |
| RuleEventDataLeadType | String | Promotion code. | |
| RuleEventDataLineItemsProductBrand | String | Product brand. | |
| RuleEventDataLineItemsProductCategory | String | Product category. | |
| RuleEventDataLineItemsProductId | Integer | Product ID. | |
| RuleEventDataLineItemsProductName | String | Product name. | |
| RuleEventDataLineItemsProductPrice | String | Product price. | |
| RuleEventDataLineItemsProductQuantity | Integer | Product quantity. | |
| RuleEventDataLineItemsProductVariant | String | Product variant. | |
| RuleEventDataLineItemsProductVariantId | String | Product variant ID. | |
| RuleEventDataOrderId | String | Order ID. | |
| RuleEventDataOrderQuantity | Integer | Order quantity. | |
| RuleEventDataPageName | String | Page name. | |
| RuleEventDataPromoCode | String | Promotion code. | |
| RuleEventDataProperty | String | Property. | |
| RuleEventDataSearchQuery | String | Search query string. | |
| RuleEventDataValue | String | Product value. | |
| RuleEventDataVideoTitle | String | Video title. | |
| RulePercentage | Integer | Percentage should be 1-10. The targeted audience should be this % size across Pinterest. | |
| RulePinId | String | Pin Id. | |
| RulePrefill | Boolean | Optional for VISITOR audience_type. The default is true. | |
| RuleRetentionDays | Integer | Number of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR audience_type. | |
| RuleSeedId | String | Seed Id. | |
| RuleUrl | String | Url. | |
| RuleVisitorSourceId | String | The conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR audience_type. | |
| RuleEventSource | String | Optional for VISITOR. You can use it as a {'=': [value]}. | |
| RuleIngestionSource | String | Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api | |
| RuleEngagerType | Integer | Optional for ENGAGEMENT. Engager type value should be 1-2. | |
| RuleCampaignId | String | Campaign Id. | |
| RuleAdId | String | Ad Id. | |
| RuleObjectiveType | String | Objective Type. | |
| RuleAdAccountId | String | Ad account ID. | |
| Size | Integer | Audience size. | |
| Status | String | Audience status.
The allowed values are READY, INITIALIZING, TOO_SMALL. | |
| Type | String | Always | |
| CreatedTime | Datetime | Creation time. Unix timestamp in seconds. | |
| UpdatedTime | Datetime | Last update time. Unix timestamp in seconds. |
Get a list of the boards owned by the User
The Sync App 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 Sync App.
SELECT * FROM Boards WHERE Id = '345787634451'
| Name | Type | References | Description |
| Id [KEY] | String | Id of the Board | |
| Name | String | Name of the Board | |
| Description | String | 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 | Pin count. | |
| FollowerCount | Integer | Follower count. | |
| CollaboratorCount | Integer | Collaborator count. | |
| CreatedAt | Datetime | Created Time. | |
| BoardPinsModifiedAt | Datetime | Modified Time. |
Get a list of the boards owned by the User
The Sync App 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 Sync App.
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 account information for the operation user_account
The Sync App 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 Sync App.
SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'
| Name | Type | References | Description |
| Id [KEY] | String | Campaign ID. | |
| AdAccountId | String |
AdAccounts.Id | Campaign's Advertiser ID. |
| CreatedTime | Datetime | Campaign creation time. | |
| DailySpendCap | Integer | Campaign total spending cap. | |
| LifetimeSpendCap | Integer | Campaign daily spending cap. | |
| Name | String | Campaign name. | |
| ObjectiveType | String | Campaign objective type.
The allowed values are AWARENESS, CONSIDERATION, WEB_CONVERSION, CATALOG_SALES, WEB_SESSIONS, VIDEO_COMPLETION. | |
| OrderLineId | String | Order line ID that appears on the invoice. | |
| Status | String | Entity status.
The allowed values are ACTIVE, PAUSED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| TrackingUrlsAudienceVerification | String | Tracking Urls Audience Verification. | |
| TrackingUrlsBuyableButton | String | Tracking Urls Buyable Button. | |
| TrackingUrlsClick | String | Tracking Urls Click. | |
| TrackingUrlsEngagement | String | Tracking Urls Engagement | |
| TrackingUrlsImpression | String | Tracking Urls Impression. | |
| Type | String | Type of campaign. | |
| UpdatedTime | Datetime | Last update time. | |
| StartTime | Datetime | Start time. | |
| EndTime | Datetime | End time. | |
| SummaryStatus | String | Summary status.
The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED, DRAFT, DELETED_DRAFT. | |
| IsFlexibleDailyBudgets | Boolean | Is Flexible Daily Budgets. | |
| IsCampaignBudgetOptimization | Boolean | Is Campaign Budget Optimization. |
Get targeting analytics for one or more campaign.
The Sync App 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 Sync App.
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 | Unique identifier of an ad account. |
| TargetingType | String | Targeting type.
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 | Id of the Campaign. |
| TargetingValues | String | Targeting type value. | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | Id of the advertiser. | |
| AdGroupEntityStatus | Double | Id of the advertiser. | |
| AdId | Double | Id of the advertiser. | |
| MetricCampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignDailySpendCap | String | Campaign daily spend cap. | |
| CampaignEntityStatus | String | Campaign entity status. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Ctr | Double | Ctr. | |
| Ctr2 | Double | Ctr2. | |
| CheckoutRoas | Double | Checkout roas. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| Ectr | Decimal | Ectr. | |
| EcpeInDollar | Decimal | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| EcpvInDollar | Decimal | Ecpv in dollars. | |
| EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
| EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| Impression2 | Integer | Impression2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| 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 | Decimal | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Decimal | 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 | Decimal | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
| Video3secViews2 | Integer | Video 3 second Views. | |
| VideoLength | Integer | VideoLength. | |
| VideoMrcViews2 | Integer | Video 2 second Views. | |
| 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 | Web checkout roas. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity.
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | 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. |
Returns the hotel catalog processing report with status, run timestamps, item counts, and error summaries.
The Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App. FeedProcessingResultId is a required column to access this view.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App. Country, Language, CatalogType, and CreativeAssetsId are required columns to access this view.
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 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 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Retrieve items from the operating user's HOTEL catalog.
The Sync App 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 Sync App. Country, Language, CatalogType, and HotelId are required columns to access this view.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Retrieve items from the retail catalog owned by the operating user account.
The Sync App 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 Sync App. Country, Language, CatalogType, and RetailItemId are required columns to access this view.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Get a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience.
The Sync App uses 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 Sync App.
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 |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| Order | String | The order in which to sort the items returned: ASCENDING or DESCENDING by ID.
The allowed values are ASCENDING, DESCENDING. |
Returns processing results for feeds, including status, run timestamps, item counts, and error summaries.
The Sync App 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 Sync App. FeedId is a required column to access this view.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| AdAccountId | String | Unique identifier of an ad account. |
Returns feeds owned by the user account associated with the operation.
The Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App.
SELECT * FROM Followers
| Name | Type | References | Description |
| Username [KEY] | String | Username | |
| Type | String | Always user |
Get a list of your followers.
The Sync App uses 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 Sync App.
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 |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App uses 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 Sync App.
Select * from FollowingBoards Select * from FollowingBoards where AdAccountId = '547362621403' Select * from FollowingBoards where ExplicitFollowing = true
| Name | Type | References | Description |
| Id [KEY] | String | ID | |
| Name | String | Name | |
| Description | String | Description | |
| 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 a user's following interests in one place.
The Sync App uses 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 Sync App.
Username is a required column to access this view.
Select * from FollowingInterests where UserName = 'etsy_UK'
| Name | Type | References | Description |
| Username | String | A valid username. | |
| Id | String | ID. | |
| Key | String | Key. | |
| Name | String | Name. | |
| CanonicalUrl | String | Canonical Url. |
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 Sync App.
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. |
Get a Pin owned by the owned by the User or on a group board that has been shared with this account
The Sync App 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 Sync App.
SELECT * FROM Pins WHERE Id = '3457832451' SELECT * FROM Pins WHERE BoardId = '3457832451'
| Name | Type | References | Description |
| Id [KEY] | String | Id of the Pin | |
| BoardId | String |
Boards.Id | Id of the Board |
| SectionId | String | Id of the Section | |
| AltText | String | AltText | |
| BoardOwnerUsername | String | UserName of the BoardOwner. | |
| CreatedAt | Datetime | Created At Date Time | |
| 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 | If the pin is removable. | |
| ProductTagsAggregate | String | The array of product tags of the Pin. |
Get targeting analytics for one or more campaign.
The Sync App 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 Sync App.
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 | Unique identifier of an ad account. |
| ProductGroupId | String | Product group Ids . | |
| Date | Date | Date the analytics row covers. | |
| SpendInDollar | Decimal | Total spend in dollars. | |
| AdvertiserId | Double | Id of the advertiser. | |
| AdGroupEntityStatus | Double | Id of the advertiser. | |
| AdId | Double | Id of the advertiser. | |
| CampaignId | String |
Campaigns.Id | Id of the Campaign. |
| CampaignDailySpendCap | String | Campaign daily spend cap. | |
| CampaignEntityStatus | String | Campaign entity status. | |
| CampaignLifetimeSpendCap | Integer | Campaign Lifetime Spend Cap. | |
| Ctr | Double | Ctr. | |
| Ctr2 | Double | Ctr2. | |
| CheckoutRoas | Double | Checkout roas. | |
| Clickthrough1 | Integer | Clickthrough1. | |
| Clickthrough2 | Integer | Clickthrough2. | |
| Clickthrough1Gross | Integer | Clickthrough1 Gross. | |
| CpcInMicroDollar | Decimal | Cpc In MicroDollar. | |
| CpmInMicroDollar | Decimal | Cpm In MicroDollar. | |
| Ectr | Decimal | Ectr. | |
| EcpeInDollar | Decimal | Ecpe in Dollars. | |
| EngagementRate | Double | The engagement rate. | |
| EengagementRate | Double | E Engagement rate. | |
| EcpvInDollar | Decimal | Ecpv in dollars. | |
| EcpcvInDollar | Decimal | E Cpcv in Dollars. | |
| EcpcvP95InDollar | Decimal | E Cpcv 95 percent in Dollars. | |
| EcpcInMicroDollar | Decimal | Ecpc In MicroDollar. | |
| EcpmInMicroDollar | Decimal | Ecpm In MicroDollar. | |
| Engagement1 | Integer | Engagement1. | |
| Engagement2 | Integer | Engagement2. | |
| Impression1 | Integer | Impression1. | |
| Impression1Gross | Integer | Impression1 Gross. | |
| Impression2 | Integer | Impression2. | |
| IdeaPinProductTagVisit1 | Integer | Idea Pin Product Tag Visit1. | |
| IdeaPinProductTagVisit2 | Integer | Idea Pin Product Tag Visit2. | |
| InAppCheckoutCostPerAction | Double | In App Checkout Cost Per Action. | |
| OutboundClick1 | Integer | Outboundclick1. | |
| OutboundClick2 | Integer | Outboundclick2. | |
| PinId | String |
Pins.Id | Id of the Pins. |
| PageVisitCostPerAction | Double | Page visit cost per action. | |
| PageVisitRoas | Double | Page visit roas. | |
| PaidImpression | Integer | PaidImpression. | |
| Repin1 | Integer | Repin1. | |
| Repin2 | Integer | Repin2. | |
| RepinRate | Double | The repin rate. | |
| TotalClickthrough | Integer | Total Clickthrough. | |
| 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 | Decimal | Total Engagement Signup Value In Micro Dollar. | |
| TotalEngagementCheckoutValueInMicroDollar | Decimal | Total Engagement Checkout Value In Micro Dollar. | |
| TotalClickSignupValueInMicroDollar | Decimal | Total Click Signup Value In Micro Dollar. | |
| TotalClickCheckoutValueInMicroDollar | Decimal | Total Click Checkout Value In Micro Dollar. | |
| TotalViewSignupValueInMicroDollar | Decimal | Total View Signup Value In Micro Dollar. | |
| TotalViewCheckoutValueInMicroDollar | Decimal | Total View Checkout Value In Micro Dollar. | |
| TotalPageVisit | Integer | Total Page Visit. | |
| TotalSignup | Integer | Total Signup. | |
| TotalCheckout | Integer | Total Checkout. | |
| TotalSignupValueInMicroDollar | Decimal | Total Signup Value In Micro Dollar. | |
| TotalCheckoutValueInMicroDollar | Decimal | 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 | Decimal | Total Web Checkout Value In Micro Dollar. | |
| TotalWebClickCheckout | Integer | Total Web Click Checkout. | |
| TotalWebClickCheckoutValueInMicroDollar | Decimal | Total Web Click Checkout Value In Micro Dollar. | |
| TotalWebEngagementCheckout | Integer | Total Web Engagement Checkout. | |
| TotalWebEngagementCheckoutValueInMicroDollar | Decimal | Total Web Engagement Checkout Value In Micro Dollar. | |
| TotalWebViewCheckout | Integer | Total Web View Checkout. | |
| TotalWebViewCheckoutValueInMicroDollar | Decimal | Total Web View Checkout Value In Micro Dollar. | |
| Video3secViews2 | Integer | Video 3 second Views. | |
| VideoLength | Integer | VideoLength. | |
| VideoMrcViews2 | Integer | Video 2 second Views. | |
| 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 | Web checkout roas. | |
| WebSessions1 | Integer | WebSessions1. | |
| WebSessions2 | Integer | WebSessions2. | |
| 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 | Granularity.
The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| ClickWindowDays | Integer | Number of days to use as the conversion attribution window for a pin click action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| EngagementWindowDays | Integer | Number of days to use as the conversion attribution window for an engagement action.
The allowed values are 1, 7, 14, 30, 60. The default value is 30. | |
| ViewWindowDays | Integer | Number of days to use as the conversion attribution window for a view action.
The allowed values are 1, 7, 14, 30, 60. The default value is 1. | |
| ConversionReportTime | 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. |
Gets all promotions associated with an ad account ID that can be applied to an ad group.
The Sync App 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 Sync App.
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. |
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. |
Get a list of the interest which are available inside the targets.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TargetingTypeAudienceExclude
| Name | Type | References | Description |
| AudienceExcludeKey | String | It contains the key of the Audience Exclude metric. | |
| AudienceExcludeValue | String | It contains the value of the Audience Exclude metric. |
Get a list of the interest which are available inside the targets.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TargetingTypeAudienceInclude
| Name | Type | References | Description |
| AudienceIncludeKey | String | It contains the key of the Audience Include metric. | |
| AudienceIncludeValue | String | It contains the value of the Audience Include metric. |
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. |
Get a list of the interest which are available inside the targets.
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
For example, the following queries are processed server side:
SELECT * FROM TargetingTypeKeyword
| Name | Type | References | Description |
| KeywordKey | String | It contains the key of the keyword. | |
| KeywordValue | String | It contains the value of the keyword. |
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 table. All criteria will be handled client side within the Sync App.
For example, the following queries are processed server side:
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 account information for the operation User Account
No filters are supported server side for this table. All criteria will be handled client side within the Sync App.
| Name | Type | References | Description |
| AccountType | String | Type of account. | |
| ProfileImage | String | Profile Image. | |
| Username | String | Username. | |
| WebsiteURL | String | Website URL. | |
| BoardCount | Integer | Board count. | |
| PinCount | Integer | Pin count. | |
| FollowerCount | Integer | Follower count. | |
| FollowingCount | Integer | Following count. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT. The default value is NO_SPLIT. | |
| AdAccountID | String | Unique identifier of an ad account. |
Get Summary Metric of User Account
The Sync App 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 Sync App.
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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT. The default value is NO_SPLIT. | |
| AdAccountID | String | Unique identifier of an ad account. |
Get analytics data about a user's top pins.
The Sync App 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 Sync App.
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. | |
| SortBy | String | Specify sorting order for metrics.
The allowed values are IMPRESSION, SAVE, OUTBOUND_CLICK, VIDEO_MRC_VIEW, VIDEO_AVG_WATCH_TIME, VIDEO_V50_WATCH_TIME, QUARTILE_95_PERCENT_VIEW, VIDEO_10S_VIEW, VIDEO_START. | |
| 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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 Sync App 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 Sync App.
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. | |
| SortBy | String | Specify sorting order for metrics.
The allowed values are ENGAGEMENT, IMPRESSION, OUTBOUND_CLICK, PIN_CLICK, SAVE. | |
| 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. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| 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.
No filters are supported server-side for this table. All criteria are handled client-side within the Sync App.
SELECT * FROM UserVerificationCodeForWebsiteClaim
| 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. |
Get user websites, claimed or not.
No filters are supported server-side for this table. All criteria are handled client-side within the Sync App.
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 Sync App 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 |
| VerifyWebsite | Verify a website as a signed-in user. |
Gets an authentication token from Pinterest.
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Scope | String | False | A comma-separated list of permissions to request from the user. Please check the Pinterest API for a list of available permissions.
The default value is ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read,catalogs:read,user_accounts:write. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Pinterest app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from Pinterest after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pinterest authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Pinterest. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Pinterest. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
| Name | Type | Required | Description |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Pinterest app settings. |
| Scope | String | False | A comma-separated list of scopes to request from the user. Please check the Pinterest API documentation for a list of available permissions.
The default value is ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read,catalogs:read,user_accounts:write. |
| State | String | False | Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pinterest authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations. |
| Name | Type | Description |
| URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
Refreshes the OAuth access token from Pinterest.
| Name | Type | Required | Description |
| OAuthRefreshToken | String | True | Set this to the token value that expired |
| Name | Type | Description |
| OAuthAccessToken | String | The access token used for communication with Pinterest. |
| OAuthRefreshToken | String | The OAuth refresh token. This is the same as the access token in the case of Pinterest. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
Verify a website as a signed-in user.
The VerifyWebsite stored procedure requires a website field to validate a website.
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. |
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 |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| 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'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
This section provides a complete list of the Connection 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.
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.
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App 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.).
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.
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.
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 Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to Pinterest. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to Pinterest. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to Pinterest. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\Pinterest Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
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.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
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. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| 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'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
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 advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the maximum number of records per page the provider returns when requesting data from Pinterest.
When processing a query, instead of requesting all of the queried data at once from Pinterest, the Sync App can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Sync App requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App 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'.
This property allows you to define which pseudocolumns the Sync App 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 the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM AdAccounts WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
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.