Skip to Content

Pinterest Connection Details

Introduction

Connector Version

This documentation is based on version 25.0.9368 of the connector.

Get Started

Pinterest Version Support

The connector leverages the Pinterest API to enable bidirectional access to Pinterest.

Establish a Connection

Connect to Pinterest

Pinterest supports OAuth authentication only. To enable this authentication from all OAuth flows, you must create a custom OAuth application, and set AuthScheme to OAuth.

The following subsections describe how to authenticate to Pinterest from three common authentication flows:

  • Desktop: a connection to a server on the user's local machine, frequently used for testing and prototyping.
  • Web: access to data via a shared website.
  • Headless Server: a dedicated computer that provides services to other computers and their users, which is configured to operate without a monitor and keyboard.

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.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

When you connect, the connector opens Pinterest's OAuth endpoint in your default browser. Log in and grant permissions to the application.

After you grant permissions to the application, the connector completes the OAuth process:

  1. The connector obtains an access token from Pinterest and uses it to request data.
  2. The OAuth values are saved in the path specified in OAuthSettingsLocation. These values persist across connections.

When the access token expires, the connector refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection parameters:
  2. On subsequent data connections, set:

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

  1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
  2. Set these connection properties:
    • OAuthClientId: The Client ID in your custom OAuth application settings.
    • OAuthClientSecret: The Client Secret in your custom OAuth application settings.
  3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
  4. After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Create a Custom OAuth Application

Create a Custom OAuth Application

The process for creating a custom OAuth application creates a new app linked to your Pinterest account, registers it in the Pinterest Developers Portal, and obtains the OAuthClientId, OAuthClientSecret, and CallbackURL.

Procedure
  1. Navigate to https://developers.pinterest.com/apps/.
  2. Log in to your Pinterest account.
  3. Click Create app.
  4. Specify an app Name and Description.
  5. Click Create.
  6. Fill the required details in the form:
    • Set Auth Callback URL to https://localhost:33333 or a different port of your choice.
    • Specify whether your custom application can be accessed by multiple users or only by the owner.
  7. Save your changes. The Pinterest Developers Portal creates the new custom OAuth application.

When application creation is complete, the Developers Portal displays a confirmation message. To reveal the new custom application's Client ID and Client Secret, click View Client ID.

Record these settings for future use.

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Pinterest APIs.

Key Features

  • The connector models Pinterest entities like documents, folders, and groups as relational views, allowing you to write SQL to query Pinterest data.
  • Stored procedures allow you to execute operations to Pinterest
  • Live connectivity to these objects means any changes to your Pinterest account are immediately reflected when using the connector.

Views

Views describes the available views. Views are statically defined to model ... here will go view names.

Views

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.

Pinterest Connector Views

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 Get the hotel catalog report
CatalogProcessingResultItemIssues Fetch feeds owned by the operation user_account
CatalogRetailReport Get the retail catalog report
Catalogs Fetch catalogs owned by the operation user_account
CatalogTypeCreativeAssetsItems Get the items of the catalog of type CREATIVE_ASSETS owned by the operation user_account
CatalogTypeHotelItems Get the items of the catalog of type HOTEL owned by the operation user_account
CatalogTypeRetailItems Get the items of the catalog of type RETAIL owned by the operation 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 Fetch feeds owned by the operation user_account
Feeds Fetch feeds owned by the operation user_account
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.

AdAccountAnalytics

Get analytics for the specified AdAccountId

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • ConversionReportTime supports the = operator.

For example:

SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime String

AdAccountAnalyticsReport

Get the ad account analytics report

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the = operator.
  • EndDate supports the = operator.
  • Granularity supports the = operator.
  • Level supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • ConversionReportTime supports the = operator.
  • AttributionTypes supports the = operator.
  • CampaignIds supports the =, and IN operators.
  • CampaignStatuses supports the =, and IN operators.
  • CampaignObjectiveTypes supports the = operator.
  • AdGroupIds supports the =, and IN operators.
  • AdGroupStatuses supports the = operator.
  • AdIds supports the =, and IN operators.
  • AdStatuses supports the = operator.
  • ProductGroupIds supports the =, and IN operators.
  • ProductGroupStatuses supports the =, and IN operators.
  • TargetingTypes supports the =, and IN operators.
  • ProductItemIds supports the =, and IN operators.

For example:

SELECT * FROM AdAccountAnalyticsReport WHERE AdAccountId = '3457832451' AND Level = 'advertiser'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
ViewWindowDays Integer
EngagementWindowDays Integer
ConversionReportTime String
AttributionTypes String
CampaignIds String
CampaignStatuses String
CampaignObjectiveTypes String
AdGroupIds String
AdGroupStatuses String
AdIds String
AdStatuses String
ProductGroupIds String
ProductGroupStatuses String
TargetingTypes String
AdsAnalyticsMetricsFilter String
ProductItemIds String

AdAccounts

Get a list of the ad_accounts that the User has access to.

Table Specific Information
Select

The connector 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 connector.

  • IncludeSharedAccounts supports the = operator.
  • Id supports the = operator.

For example:

SELECT * FROM AdAccounts
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IncludeSharedAccounts Boolean

AdAccountTargetingAnalytics

Get targeting analytics for an ad account.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • TargetingTypes supports the = operator.

For example:

SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AttributionTypes String
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

AdAnalytics

Get analytics for the ads in the specified AdAccountId

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • AdId supports the =, and IN operators.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • ConversionReportTime supports the = operator.

For example:

SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'
SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
Name Type References Description
AdId String Ads.Id Id of the ad
AdAccountId String AdAccounts.Id Id of the ad account
Date Date Current metrics date. Only returned when granularity is a time-based value.
CampaignEntityStatus String Status of the campaign.
AdGroupEntityStatus String Status of the ad group.
SpendInDollar Double Total spend in dollars.
EcpcInDollar Double Ecpc in dollars.
Ctr Double Ctr.
Ectr Double Ectr.
EcpeInDollar Double Ecpe in Dollars.
EngagementRate Double The engagement rate.
EengagementRate Double E Engagement rate.
RepinRate Double The repin rate.
Ctr2 Double Ctr2
CpmInDollar Double Cpm in Dollars.
WebCheckoutCostPerAction Double Web checkout cost per action.
WebCheckoutRoas Double Web checkout roas
PageVisitCostPerAction Double Page visit cost per action.
PageVisitRoas Double Page visit roas.
CheckoutRoas Double Checkout roas.
Video3secViews2 Integer Videos with at least 3 seconds of viewing.
VideoP100Complete2 Integer Videos 100 percent complete
VideoP0Combined2 Integer Videos 0 percent combined viewed.
VideoP25Combined2 Integer Videos 25 percent combined viewed.
VideoP50Combined2 Integer Video 50 percent combined viewed.
VideoP75Combined2 Integer Video 75 percent combined viewed.
VideoP95Combined2 Integer Video 95 percent combined viewed.
VideoMrcViews2 Integer Video Mrc Views.
EcpvInDollar Double Ecpv in dollars.
EcpcvInDollar Double E Cpcv in Dollars
EcpcvP95InDollar Double E Cpcv 95 percent in Dollars.
TotalClickthrough Integer Total Clickthrough.
TotalImpressionFrequency Double Total Impression Frequency.
TotalEngagementSignup Integer Total Engagement Signup.
TotalEngagementCheckout Integer Total Engagement Checkout.
TotalClickSignup Integer Total Click Signup.
TotalClickCheckout Integer Total Click Checkout.
TotalViewSignup Integer Total View Signup.
TotalViewCheckout Integer Total View Checkout.
TotalConversions Integer Total Conversions.
TotalEngagementSignupValueInMicroDollar Double Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar Double Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar Double Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar Double Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar Double Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar Double Total View Checkout Value In Micro Dollar.
TotalPageVisit Integer Total Page Visit.
TotalSignup Integer Total Signup.
TotalCheckout Integer Total Checkout.
TotalSignupValueInMicroDollar Double Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar Double Total Checkout Value In Micro Dollar.
TotalVideo3secViews Integer Total Video 3 second Views.
TotalVideoP100Complete Integer Total Video 100 percent Complete.
TotalVideoP0Combined Integer Total Video 0 percent Combined.
TotalVideoP25Combined Integer Total Video 25 percent Combined.
TotalVideoP50Combined Integer Total Video 50 percent Combined.
TotalVideoP75Combined Integer Total Video 75 percent Combined.
TotalVideoP95Combined Integer Total Video 95 percent Combined.
TotalVideoMrcViews Integer Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond Integer Total Video Avg Watchtime In Seconds.
TotalRepinRate Double Total Repin Rate.
TotalWebCheckout Integer Total Web Checkout.
TotalWebCheckoutValueInMicroDollar Double Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout Integer Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar Double Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout Integer Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar Double Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout Integer Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar Double Total Web View Checkout Value In Micro Dollar.
Clickthrough1 Integer Clickthrough1.
Clickthrough1Gross Integer Clickthrough1 Gross.
Impression1 Integer Impression1.
Impression1Gross Integer Impression1 Gross.
CampaignId String Campaigns.Id Id of the Campaign.
AdvertiserId String Id of the ad account
AdGroupId String AdGroups.Id Id of the ad group.
CampaignDailySpendCap Integer Campaign daily spend cap.
CampaignLifetimeSpendCap Integer Campaign Lifetime Spend Cap.
CampaignName String Name of the Campaign
Clickthrough2 Integer Clickthrough2.
CpcInMicroDollar Decimal Cpc In MicroDollar.
CpmInMicroDollar Decimal Cpm In MicroDollar.
EcpcInMicroDollar Decimal Ecpc In MicroDollar.
EcpmInMicroDollar Decimal Ecpm In MicroDollar.
Engagement1 Integer Engagement1.
Engagement2 Integer Engagement2.
IdeaPinProductTagVisit1 Integer Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2 Integer Idea Pin Product Tag Visit2.
Impression2 Integer Impression2.
InAppCheckoutCostPerAction Double In App Checkout Cost Per Action.
OutboundClick1 Integer Outboundclick1.
OutboundClick2 Integer Outboundclick2.
PaidImpression Integer PaidImpression.
PinId String Pins.Id Id of the Pins.
Repin1 Integer Repin1.
Repin2 Integer Repin2.
SpendInMicroDollar Decimal Total spend in dollars.
TotalClickAddToCart Integer Total click add to cart.
TotalClickLead Integer Total click lead.
TotalCustom Integer Total custom.
TotalEngagement Integer Total Engagement.
TotalEngagementLead Integer Total Engagement Lead.
TotalIdeaPinProductTagVisit Integer Total Idea Pin Product Tag Visit.
TotalImpressionUser Integer Total Impression User.
TotalLead Integer Total Lead.
TotalOfflineCheckout Integer Total offline checkout.
TotalViewAddToCart Integer Total view add to cart.
TotalViewLead Integer Total view Lead.
TotalWebSessions Integer Total web sessions.
VideoLength Integer VideoLength.
WebSessions1 Integer WebSessions1.
WebSessions2 Integer WebSessions2.
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime String

AdCampaignAnalytics

Get analytics for the specified campaigns in the specified AdAccountId

Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime String

AdGroupAnalytics

Get analytics for the ad groups in the specified AdAccountId

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • AdGroupId supports the =, and IN operators.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • ConversionReportTime supports the = operator.

For example:

SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'
SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

AdGroups

Get a list of the ad_accounts that the User has access to.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • Id supports the =, and IN operators.
  • Status supports the = operator.
  • TranslateInterestsToNames supports the = operator.

For example:

SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
TranslateInterestsToNames Boolean

AdGroupTargetingAnalytics

Get targeting analytics for one or more ad groups.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • AdGroupId supports the '=,IN' operators.
  • TargetingType supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • ConversionReportTime supports the = operator.

For example:

SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'
SELECT * FROM AdGroupTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AttributionTypes String
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

Ads

Get a list of the ad_accounts that the User has access to.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • Id supports the =, and IN operators.
  • AdGroupId supports the =, and IN operators.
  • CampaignId supports the =, and IN operators.
  • Status supports the = operator.

For example:

SELECT * FROM Ads WHERE AdAccountId = '3457832451'
Columns
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.

AdsTargetingAnalytics

Get targeting analytics for one or more ads.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • TargetingTypes supports the = operator.
  • AdId supports the = operator.

For example:

SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AttributionTypes String
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

AudienceInsights

Get Audience Insights for an ad account.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountID supports the = operator.
  • Type supports the = operator.

For example:

Select * from AudienceInsights
Select * from AudienceInsights where AdAccountId = '54736262148'
Select * from AudienceInsights where Type = 'PINTEREST_TOTAL_AUDIENCE'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountID String

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.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountID supports the = operator.

For example:

Select * from AudienceInsightsScopeAndType
Select * from AudienceInsightsScopeAndType where AdAccountId = '547362621403'
Columns
Name Type References Description
Date Datetime Generation date.
Type String Type.
Scope String Scope.
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountID String

Audiences

Get list of audiences for the ad account.

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • AdAccountId supports the = operator.

For example:

SELECT * FROM Audiences WHERE Id = '2542622901002'
SELECT * FROM Audiences WHERE AdAccountId = '549768233165'
Columns
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.

Boards

Get a list of the boards owned by the User

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • Privacy supports the = operator.

For example:

SELECT * FROM Boards WHERE ID = '345787634451'
Columns
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.

BoardSections

Get a list of the boards owned by the User

Table Specific Information
Select

The connector 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 connector.

  • BoardId supports the = operator.

For example:

SELECT * FROM BoardSections WHERE BoardId = '345787634451'
Columns
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.

Campaigns

Get account information for the operation user_account

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • Id supports the =, and IN operators.
  • Status supports the = operator.

For example:

SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'
Columns
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.

CampaignTargetingAnalytics

Get targeting analytics for one or more campaign.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • TargetingTypes supports the = operator.
  • CampaignId supports the = operator.

For example:

SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM CampaignTargetingAnalytics WHERE CampaignId = '451'
SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AttributionTypes String
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

CatalogHotelReport

Get the hotel catalog report

Table Specific Information
Select

The connector 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 connector.

  • CatalogId supports the = operator.
  • CatalogType supports the = operator.
  • ReportType supports the = operator.
  • FeedId supports the = operator.
  • ProcessingResultId supports the = operator.
  • AdAccountId supports the = operator.

For example:

Select * from CatalogHotelReport
Select * from CatalogHotelReport where CatalogId='4853306950123'
Select * from CatalogHotelReport where AdAccountId = '549768233165'
Select * from CatalogHotelReport where CatalogType = 'RETAIL'
Select * from CatalogHotelReport where ReportType='DISTRIBUTION_ISSUES'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CatalogType String
ReportType String
FeedId String
ProcessingResultId String
AdAccountId String

CatalogProcessingResultItemIssues

Fetch feeds owned by the operation user_account

Table Specific Information
Select

The connector 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 connector. FeedProcessingResultId is a required column to access this view.

  • ItemNumber supports the = operator.
  • AdAccountId supports the = operator.
  • ItemValidationIssue supports the = operator.

For example:

Select * from CatalogProcessingResultItemIssues where FeedProcessingResultId = '1249732834965724159'
Select * from CatalogProcessingResultItemIssues where FeedProcessingResultId = '1249732834965724159' AND ItemNumber = '0'
SELECT * from CatalogProcessingResultItemIssues where FeedProcessingResultId = '1249732834965724159' AND AdAccountId = '549768518755'
Columns
Name Type References Description
ItemId [KEY] String The merchant-created unique ID that represents the product.
FeedProcessingResultId String FeedProcessingResults.Id 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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String
ItemValidationIssue String

CatalogRetailReport

Get the retail catalog report

Table Specific Information
Select

The connector 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 connector.

  • CatalogId supports the = operator.
  • CatalogType supports the = operator.
  • ReportType supports the = operator.
  • FeedId supports the = operator.
  • ProcessingResultId supports the = operator.
  • AdAccountId supports the = operator.

For example:

Select * from CatalogRetailReport
Select * from CatalogRetailReport where CatalogId='4853306950123'
Select * from CatalogRetailReport where AdAccountId = '549768233165'
Select * from CatalogRetailReport where CatalogType = 'RETAIL'
Select * from CatalogRetailReport where ReportType='DISTRIBUTION_ISSUES'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CatalogType String
ReportType String
FeedId String
ProcessingResultId String
AdAccountId String

Catalogs

Fetch catalogs owned by the operation user_account

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.

For example:

SELECT * FROM Catalogs WHERE AdAccountId = '549768233165'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String

CatalogTypeCreativeAssetsItems

Get the items of the catalog of type CREATIVE_ASSETS owned by the operation user_account

Table Specific Information
Select

The connector 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 connector. Country, Language, CatalogType, and CreativeAssetsId are required columns to access this view.

  • CatalogId supports the = operator.
  • CatalogType supports the = operator.
  • CreativeAssetsId supports the = operator.
  • Country supports the = operator.
  • Language supports the = operator.
  • AdAccountId supports the = operator.

For example:

Select * from CatalogTypeCreativeAssetsItems where Country='US' AND Language='en-US' AND CatalogType = 'CREATIVE_ASSETS' AND CreativeAssetsId = '1122,07'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String

CatalogTypeHotelItems

Get the items of the catalog of type HOTEL owned by the operation user_account

Table Specific Information
Select

The connector 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 connector. Country, Language, CatalogType, and HotelId are required columns to access this view.

  • CatalogId supports the = operator.
  • CatalogType supports the = operator.
  • HotelId supports the = operator.
  • Country supports the = operator.
  • Language supports the = operator.
  • AdAccountId supports the = operator.

For example:

Select * from CatalogTypeHotelItems where Country='US' AND Language='en-US' AND CatalogType = 'HOTEL' AND HotelId = '1122,07'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String

CatalogTypeRetailItems

Get the items of the catalog of type RETAIL owned by the operation user_account

Table Specific Information
Select

The connector 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 connector. Country, Language, CatalogType, and RetailItemId are required columns to access this view.

  • CatalogId supports the = operator.
  • CatalogType supports the = operator.
  • RetailItemId supports the = operator.
  • Country supports the = operator.
  • Language supports the = operator.
  • AdAccountId supports the = operator.

For example:

Select * from CatalogTypeRetailItems where Country='US' AND Language='en-US' AND CatalogType = 'RETAIL' AND RetailItemId = '31176763998231,39870493392919,39870493458455'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String

CustomerLists

Get a set of customer lists including ID and name based on the filters provided. Customer lists are a type of audience.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountID supports the = operator.
  • ID supports the = operator.
  • Order supports the = operator.

For example:

Select * from CustomerLists
Select * from CustomerLists where AdAccountId = '547362621403'
Select * from CustomerLists where Id = '12575858432'
Select * from CustomerLists where [Order] = 'ASCENDING'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
Order String

FeedProcessingResults

Fetch feeds owned by the operation user_account

Table Specific Information
Select

The connector 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 connector. FeedId is a required column to access this view.

  • AdAccountId supports the = operator.

For example:

Select * from FeedProcessingResults where FeedId = '1540904175633'
Select * from FeedProcessingResults where FeedId = '1540904175633' AND AdAccountId = '549768518755'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String

Feeds

Fetch feeds owned by the operation user_account

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • AdAccountId supports the = operator.
  • CatalogId supports the = operator.

For example:

SELECT * FROM Feeds WHERE Id = '2542622901002'
SELECT * FROM Feeds WHERE AdAccountId = '549768233165'
SELECT * FROM Feeds WHERE CatalogId = '4842503688348'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountId String
CatalogId String

Followers

Get a list of your followers.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

SELECT * FROM Followers
Columns
Name Type References Description
Username [KEY] String Username
Type String Always user

Following

Get a list of your followers.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountID supports the = operator.
  • ExplicitFollowing supports the = operator.
  • FeedType supports the = operator.

For example:

Select * from Following
Select * from Following where AdAccountId = '547362621403'
Select * from Following where FeedType = 'ALL'
Select * from Following where ExplicitFollowing = true
Columns
Name Type References Description
Username [KEY] String Username
Type String Always user
Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FeedType String
ExplicitFollowing Boolean
AdAccountID String

FollowingBoards

Get a list of the boards a user follows.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountID supports the = operator.
  • ExplicitFollowing supports the = operator.

For example:

Select * from FollowingBoards
Select * from FollowingBoards where AdAccountId = '547362621403'
Select * from FollowingBoards where ExplicitFollowing = true
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ExplicitFollowing Boolean
AdAccountID String

FollowingInterests

Get a list of a user's following interests in one place.

Table Specific Information
Select

The connector 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 connector.

Username is a required column to access this view.

  • Username supports the = operator.

For example:

Select * from FollowingInterests where UserName = 'etsy_UK'
Columns
Name Type References Description
Username String A valid username.
Id String ID.
Key String Key.
Name String Name.
CanonicalUrl String Canonical Url.

LinkedBusinesses

Get a list of your linked business accounts.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

SELECT * FROM LinkedBusinesses
Columns
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.

Pins

Get a Pin owned by the owned by the User or on a group board that has been shared with this account

Table Specific Information
Select

The connector 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 connector.

  • Id supports the = operator.
  • BoardId supports the = operator.
  • SectionId supports the = operator.

For example:

SELECT * FROM Pins WHERE Id = '3457832451'
SELECT * FROM Pins WHERE BoardId = '3457832451'
Columns
Name Type References Description
Id [KEY] String Id of the Pin
BoardId String Boards.Id Id of the Board
SectionId String BoardSections.Id 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.

ProductGroupAnalytics

Get targeting analytics for one or more campaign.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.
  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • Granularity supports the = operator.
  • ClickWindowDays supports the = operator.
  • EngagementWindowDays supports the = operator.
  • ViewWindowDays supports the = operator.
  • TargetingTypes supports the = operator.
  • ProductGroupId supports the = operator.

For example:

SELECT * FROM ProductGroupAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451'
SELECT * FROM ProductGroupAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
ClickWindowDays Integer
EngagementWindowDays Integer
ViewWindowDays Integer
ConversionReportTime Integer

Promotions

Gets all promotions associated with an ad account ID that can be applied to an ad group.

Table Specific Information
Select

The connector 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 connector.

  • AdAccountId supports the = operator.

For example:

SELECT * FROM Promotions where AdAccountId='549768561505';
Columns
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.

TargetingTypeAgeBucket

Get a list of the age bucket which are available inside the targets.

Columns
Name Type References Description
AgeBucketKey String It contains the key of the age bucket.
AgeBucketValue String It contains the value of the age bucket.

TargetingTypeAppType

Get a list of the app type which are available inside the targets.

Columns
Name Type References Description
AppKey String It contains the key of the apptype.
AppValue String It contains the value of the apptype.

TargetingTypeAudienceExclude

Get a list of the interest which are available inside the targets.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following queries are processed server side:

SELECT * FROM TargetingTypeAudienceExclude
Columns
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.

TargetingTypeAudienceInclude

Get a list of the interest which are available inside the targets.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following queries are processed server side:

SELECT * FROM TargetingTypeAudienceInclude
Columns
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.

TargetingTypeGender

Get a list of the gender which are available inside the targets.

Columns
Name Type References Description
GenderKey String It contains the key of the gender.
GenderValue String It contains the value of the gender.

TargetingTypeGeo

Get a list of the geo which are available inside the targets.

Columns
Name Type References Description
GeoKey String It contains the key of the Geo.
GeoValue String It contains the value of the Geo.

TargetingTypeInterests

Get a list of the interest which are available inside the targets.

Columns
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.

TargetingTypeKeyword

Get a list of the interest which are available inside the targets.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following queries are processed server side:

SELECT * FROM TargetingTypeKeyword
Columns
Name Type References Description
KeywordKey String It contains the key of the keyword.
KeywordValue String It contains the value of the keyword.

TargetingtypeLocale

Get a list of the locale which are available inside the targets.

Columns
Name Type References Description
LocaleKey String It contains the key of the locale
LocaleValue String It contains the value of the locale

TargetingTypeLocations

Get a list of the location which are available inside the targets.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

For example, the following queries are processed server side:

SELECT * FROM TargetingTypeLocations
Columns
Name Type References Description
LocationKey String It contains the key of the Location
LocationValue String It contains the value of the Location

UserAccount

Get account information for the operation User Account

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
AdAccountID String

UserAccountDailyMetrics

Get Daily Metric of User Account

Table Specific Information
Select

The connector 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 connector.

  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • FromClaimedContent supports the = operator.
  • PinFormat supports the = operator.
  • AppTypes supports the = operator.
  • MetricTypes supports the = operator.
  • SplitFields supports the = operator.
  • AdAccountID supports the = operator.

For example:

SELECT * FROM UserAccountDailyMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountDailyMetrics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromClaimedContent String
PinFormat String
AppTypes String
MetricTypes String
SplitField String
AdAccountID String

UserAccountSummaryMetrics

Get Summary Metric of User Account

Table Specific Information
Select

The connector 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 connector.

  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • FromClaimedContent supports the = operator.
  • PinFormat supports the = operator.
  • AppTypes supports the = operator.
  • MetricTypes supports the = operator.
  • SplitFields supports the = operator.
  • AdAccountID supports the = operator.

For example:

SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountSummaryMetrics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
FromClaimedContent String
PinFormat String
AppTypes String
MetricTypes String
SplitField String
AdAccountID String

UserAccountTopVideoPinAnalytics

Get analytics data about a user's top pins.

Table Specific Information
Select

The connector 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 connector.

  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • SortBy supports the = operator.
  • CreatedInLastNDays supports the = operator.
  • NumOfPins supports the = operator.
  • MetricTypes supports the = operator.
  • AppType supports the = operator.
  • PiFormat supports the = operator.
  • FromClaimedContent supports the = operator.

For example:

SELECT * FROM UserAccountTopVideoPinAnalytics WHERE SortBy = 'IMPRESSION'
SELECT * FROM UserAccountTopVideoPinAnalytics WHERE AppType = 'ALL'
SELECT * FROM UserAccountTopVideoPinAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CreatedInLastNDays Integer
NumOfPins Integer
MetricTypes String
AppType String
PinFormat String
FromClaimedContent String

UserTopPinAnalytics

Get analytics data about a user's top pins.

Table Specific Information
Select

The connector 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 connector.

  • StartDate supports the =, >, and >= operators.
  • EndDate supports the =, <, and <= operators.
  • SortBy supports the = operator.
  • CreatedInLastNDays supports the = operator.
  • NumOfPins supports the = operator.
  • MetricTypes supports the = operator.
  • AppType supports the = operator.
  • PiFormat supports the = operator.
  • FromClaimedContent supports the = operator.

For example:

SELECT * FROM UserTopPinAnalytics WHERE SortBy = 'IMPRESSION'
SELECT * FROM UserTopPinAnalytics WHERE AppType = 'ALL'
SELECT * FROM UserTopPinAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'
Columns
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-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CreatedInLastNDays Integer
NumOfPins Integer
MetricTypes String
AppType String
PinFormat String
FromClaimedContent String

UserVerificationCodeForWebsiteClaim

Get verification code for user to install on the website to claim it.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

SELECT * FROM UserVerificationCodeForWebsiteClaim
Columns
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.

UserWebsites

Get user websites, claimed or not.

Table Specific Information
Select

No filters are supported server side for this table. All criteria will be handled client side within the connector.

SELECT * FROM UserWebsites
Columns
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

Stored procedures are function-like interfaces that extend the functionality of the connector 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.

Pinterest Connector Stored Procedures

Name Description
GetOAuthAccessToken Gets an authentication token from Pinterest.
GetOAuthAuthorizationURL 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.
RefreshOAuthAccessToken Refreshes the OAuth access token from Pinterest.
VerifyWebsite Verify a website as a signed-in user.

GetOAuthAccessToken

Gets an authentication token from Pinterest.

Input
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.
Result Set Columns
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.

GetOAuthAuthorizationURL

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.

Input
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.
Result Set Columns
Name Type Description
URL String The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

RefreshOAuthAccessToken

Refreshes the OAuth access token from Pinterest.

Input
Name Type Required Description
OAuthRefreshToken String True Set this to the token value that expired
Result Set Columns
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.

VerifyWebsite

Verify a website as a signed-in user.

Stored Procedure Specific Information

The VerifyWebsite Stored Procedure requires Website field to verify a website.

EXEC VerifyWebsite @Website = 'pintest-website-12345678.test/test_2', @VerificationMethod = FILENAME
Input
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.
Result Set Columns
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.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Pinterest:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the AdAccounts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdAccounts'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.
IsReadOnly Boolean Whether the column is read-only.
IsKey Boolean Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType String The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the SelectEntries stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName String The name of the data type.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.
Values String The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams Boolean Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath Boolean Whether the parameter is a target path for a schema creation operation.
Default String The value used for this parameter when no value is specified.
SpecificName String A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsProvided Boolean Whether the procedure is added/implemented by , as opposed to being a native Pinterest procedure.
Pseudo-Columns
Name Type Description
IncludeResultColumns Boolean Whether the output should include columns from the result set in addition to parameters. Defaults to False.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the AdAccounts table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAccounts'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

sys_information

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information
Columns
Name Type Description
Product String The name of the product.
Version String The version number of the product.
Datasource String The name of the datasource the product connects to.
NodeId String The unique identifier of the machine where the product is installed.
HelpURL String The URL to the product's help documentation.
License String The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location String The file path location where the product's library is stored.
Environment String The version of the environment or rumtine the product is currently running under.
DataSyncVersion String The tier of Sync required to use this connector.
DataSyncCategory String The category of Sync functionality (e.g., Source, Destination).

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Connection

Property Description
AdAccountId Unique identifier of an Ad Account.

OAuth

Property Description
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
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.
OAuthAccessToken Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
CallbackURL Identifies the URL users return to after authenticating to Pinterest via OAuth. (Custom OAuth applications only.).
Scope Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.
OAuthVerifier Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthRefreshToken Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

SSL

Property Description
SSLServerCert Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Schema

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.

Miscellaneous

Property Description
MaxRows Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize The maximum number of records per page the provider returns when requesting data from Pinterest.
PseudoColumns Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Connection

This section provides a complete list of connection properties you can configure.

Property Description
AdAccountId Unique identifier of an Ad Account.

AdAccountId

Unique identifier of an Ad Account.

Data Type

string

Default Value

""

Remarks

Driver will use this Account where required. If not fed, it will pick the first Ad Account configured for the Account.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.
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.
OAuthAccessToken Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.
OAuthSettingsLocation Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.
CallbackURL Identifies the URL users return to after authenticating to Pinterest via OAuth. (Custom OAuth applications only.).
Scope Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.
OAuthVerifier Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.
OAuthRefreshToken Specifies the OAuth refresh token used to request a new access token after the original has expired.
OAuthExpiresIn Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.
OAuthTokenTimestamp Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

InitiateOAuth

Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.

Possible Values

OFF, REFRESH, GETANDREFRESH

Data Type

string

Default Value

OFF

Remarks

OAuth is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service. The OAuth flow defines the method to be used for logging in users, exchanging their credentials for an OAuth access token to be used for authentication, and providing limited access to applications.

Pinterest supports the following options for initiating OAuth access:

  1. OFF: No automatic OAuth flow initiation. The OAuth flow is handled entirely by the user, who will take action to obtain their OAuthAccessToken. Note that with this setting the user must refresh the token manually and reconnect with an updated OAuthAccessToken property when the current token expires.
  2. GETANDREFRESH: The OAuth flow is handled entirely by the connector. If a token already exists, it is refreshed when necessary. If no token currently exists, it will be obtained by prompting the user to login.
  3. REFRESH: The user handles obtaining the OAuth Access Token and sets up the sequence for refreshing the OAuth Access Token. (The user is never prompted to log in to authenticate. After the user logs in, the connector handles the refresh of the OAuth Access Token.

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.

Data Type

string

Default Value

""

Remarks

This property is required when using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration. It is also required if an embedded OAuth application is not available for the driver. When an embedded OAuth application is available, this value may already be provided by the connector and not require manual entry.

This value 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 typically 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.

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.

Data Type

string

Default Value

""

Remarks

This property 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 will fail, and the server may return an invalid_client or 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. It may be referred to as the client secret, application secret, or consumer secret.

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments. Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

OAuthAccessToken

Specifies the OAuth access token used to authenticate requests to the data source. This token is issued by the authorization server after a successful OAuth exchange.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken is a temporary credential that authorizes access to protected resources. It is typically returned by the identity provider after the user or client application completes an OAuth authentication flow. This property is most commonly used in automated workflows or custom OAuth implementations where you want to manage token handling outside of the driver.

The OAuth access token has a server-dependent timeout, limiting user access. This is set using the OAuthExpiresIn property. However, it can be reissued between requests to keep access alive as long as the user keeps working.

If InitiateOAuth is set to REFRESH, we recommend that you also set both OAuthExpiresIn and OAuthTokenTimestamp. The connector uses these properties to determine when the token expires so it can refresh most efficiently. If OAuthExpiresIn and OAuthTokenTimestamp are not specified, the connector refreshes the token immediately.

Access tokens should be treated as sensitive credentials and stored securely. Avoid exposing them in logs, scripts, or configuration files that are not access-controlled.

OAuthSettingsLocation

Specifies the location of the settings file where OAuth values are saved. Storing OAuth settings in a central location avoids the need for users to enter OAuth connection properties manually each time they log in. It also enables credentials to be shared across connections or processes.

Data Type

string

Default Value

%APPDATA%\Pinterest Data Provider\OAuthSettings.txt

Remarks

You can store OAuth values in a central file for shared access to those values, in either of the following ways:

  • Set InitiateOAuth to either GETANDREFRESH or REFRESH and specify a filepath to the OAuth settings file.
  • Use memory storage to load the credentials into static memory.

The following sections provide more detail on each of these methods.

Specifying the OAuthSettingsLocation Filepath

The default OAuth setting location is %APPDATA%\Pinterest Data Provider\OAuthSettings.txt, with %APPDATA% set to the user's configuration directory.

Default values vary, depending on the user's operating system.

  • Windows (ODBC and Power BI): registry://%DSN%
  • Windows: %APPDATA%Pinterest Data Provider\OAuthSettings.txt
  • Mac: %APPDATA%//Pinterest Data Provider/OAuthSettings.txt
  • Linux: %APPDATA%//Pinterest Data Provider/OAuthSettings.txt
Loading Credentials Via Memory Storage

Memory locations are specified by using a value starting with memory://, followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose, but it should be unique to the user.

Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again.

To retrieve OAuth property values, query the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

Supported Storage Types

  • memory://: Stores OAuth tokens in-memory (unique identifier, shared within same process, etc.)
  • registry://: Only supported in the Windows ODBC and Power BI editions. Stores OAuth tokens in the registry under the DSN settings. Must end in a DSN name like registry://Pinterest connector Data Source, or registry://%DSN%.
  • %DSN%: The name of the DSN you are connecting with.
  • Default (no prefix): Stores OAuth tokens within files. The value can be either an absolute path, or a path starting with %APPDATA% or %PROGRAMFILES%.

CallbackURL

Identifies the URL users return to after authenticating to Pinterest via OAuth. (Custom OAuth applications only.).

Data Type

string

Default Value

https://localhost:33333/

Remarks

If you created a custom OAuth application, the OAuth authorization server redirects the user to this URL during the authentication process. This value must match the callback URL you specified when you Configured the custom OAuth application.

Scope

Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.

Data Type

string

Default Value

""

Remarks

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 use either this property or the Scope input to change which scopes are requested.

OAuthVerifier

Specifies a verifier code returned from the OAuthAuthorizationURL. Used when authenticating to OAuth on a headless server, where a browser can't be launched. Requires both OAuthSettingsLocation and OAuthVerifier to be set.

Data Type

string

Default Value

""

OAuthRefreshToken

Specifies the OAuth refresh token used to request a new access token after the original has expired.

Data Type

string

Default Value

""

Remarks

The refresh token is used to obtain a new access token when the current one expires. It enables seamless authentication for long-running or automated workflows without requiring the user to log in again. This property is especially important in headless, CI/CD, or server-based environments where interactive authentication is not possible.

The refresh token is typically obtained during the initial OAuth exchange by calling the GetOAuthAccessToken stored procedure. After that, it can be set using this property to enable automatic token refresh, or passed to the RefreshOAuthAccessToken stored procedure if you prefer to manage the refresh manually.

When InitiateOAuth is set to REFRESH, the driver uses this token to retrieve a new access token automatically. After the first refresh, the driver saves updated tokens in the location defined by OAuthSettingsLocation, and uses those values for subsequent connections.

The OAuthRefreshToken should be handled securely and stored in a trusted location. Like access tokens, refresh tokens can expire or be revoked depending on the identity provider’s policies.

OAuthExpiresIn

Specifies the duration in seconds, of an OAuth Access Token's lifetime. The token can be reissued to keep access alive as long as the user keeps working.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthExpiresIn is the number of seconds the token is valid from when it was created. For example, a token generated at 2024-01-29 20:00:00 UTC that expires at 2024-01-29 21:00:00 UTC (an hour later) would have an OAuthExpiresIn value of 3600, no matter what the current time is.

To determine how long the user has before the Access Token will expire, use OAuthTokenTimestamp.

OAuthTokenTimestamp

Displays a Unix epoch timestamp in milliseconds that shows how long ago the current Access Token was created.

Data Type

string

Default Value

""

Remarks

The OAuth Access Token is assigned to an authenticated user, granting that user access to the network for a specified period of time. The access token is used in place of the user's login ID and password, which stay on the server.

An access token created by the server is only valid for a limited time. OAuthTokenTimestamp is the Unix timestamp when the server created the token. For example, OAuthTokenTimestamp=1706558400 indicates the OAuthAccessToken was generated by the server at 2024-01-29 20:00:00 UTC.

SSL

This section provides a complete list of SSL properties you can configure.

Property Description
SSLServerCert Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is 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

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

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.

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.

Data Type

string

Default Value

%APPDATA%\Pinterest Data Provider\Schema

Remarks

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%\Pinterest Data Provider\Schema, where %APPDATA% is set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

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.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

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.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

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.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
MaxRows Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize The maximum number of records per page the provider returns when requesting data from Pinterest.
PseudoColumns Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

This property sets an upper limit on the number of rows the connector returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Data Type

string

Default Value

""

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in 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.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
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.

Pagesize

The maximum number of records per page the provider returns when requesting data from Pinterest.

Data Type

int

Default Value

250

Remarks

When processing a query, instead of requesting all of the queried data at once from Pinterest, the connector can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the connector requests per page.

Note that setting large page sizes may improve overall query execution time, but doing so causes the connector to use more memory when executing queries and risks triggering a timeout.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the connector 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: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Data Type

int

Default Value

60

Remarks

This property controls the maximum time, in seconds, that the connector waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the connector cancels the operation and throws an exception.

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 the timeout value if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing 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. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Data Type

string

Default Value

""

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the connector 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 define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the connector.

Refer to User Defined Views for more information.