Pinterest Connector for CData Sync

Build 23.0.8839
  • Pinterest
    • Establishing a Connection
    • Data Model
      • Views
        • AdAccountAnalytics
        • AdAccountAnalyticsReport
        • AdAccounts
        • AdAccountTargetingAnalytics
        • AdAnalytics
        • AdCampaignAnalytics
        • AdGroupAnalytics
        • AdGroups
        • AdGroupTargetingAnalytics
        • Ads
        • AdsTargetingAnalytics
        • Boards
        • BoardSections
        • Campaigns
        • CampaignTargetingAnalytics
        • Pins
        • ProductGroupAnalytics
        • TargetingTypeAgeBucket
        • TargetingTypeAppType
        • TargetingTypeGender
        • TargetingTypeGeo
        • TargetingTypeInterests
        • TargetingtypeLocale
        • TargetingTypeLocations
        • UserAccount
        • UserAccountDailyMetrics
        • UserAccountSummaryMetrics
        • UserAccountTopVideoPinAnalytics
        • UserTopPinAnalytics
    • Connection String Options
      • Connection
        • AdAccountId
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
      • SSL
        • SSLServerCert
      • Firewall
        • FirewallType
        • FirewallServer
        • FirewallPort
        • FirewallUser
        • FirewallPassword
      • Proxy
        • ProxyAutoDetect
        • ProxyServer
        • ProxyPort
        • ProxyAuthScheme
        • ProxyUser
        • ProxyPassword
        • ProxySSLType
        • ProxyExceptions
      • Logging
        • LogModules
      • Schema
        • Location
        • BrowsableSchemas
        • Tables
        • Views
      • Miscellaneous
        • MaxRows
        • Other
        • PseudoColumns
        • Timeout
        • UserDefinedViews

Pinterest Connector for CData Sync

Overview

The CData Sync App provides a straightforward way to continuously pipeline your Pinterest data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.

The Pinterest connector can be used from the CData Sync application to pull data from Pinterest and move it to any of the supported destinations.

Pinterest Version Support

The Sync App leverages the Pinterest API to enable bidirectional access to Pinterest.

Pinterest Connector for CData Sync

Establishing a Connection

Adding a Connection to Pinterest

To add a connection to Pinterest:

  1. In the application console, navigate to the Connections page.
  2. At the Add Connections panel, select the icon for the connection you want to add.
  3. If the Pinterest icon is not available, click the Add More icon to download and install the Pinterest connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

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

Automatic refresh of the OAuth access token:

To have the Sync App automatically refresh the OAuth access token:

  1. Before connecting to data for the first time, set these connection parameters:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id in your custom OAuth application settings.
    • OAuthClientSecret: The client secret in your custom OAuth application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the Sync App to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set:
    • InitiateOAuth
    • OAuthSettingsLocation

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.

Pinterest Connector for CData Sync

Data Model

Overview

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

Key Features

  • The Sync App 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 Sync App.

Views

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

Pinterest Connector for CData Sync

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 for CData Sync 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.
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.
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.
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.
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.
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.

Pinterest Connector for CData Sync

AdAccountAnalytics

Get analytics for the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • ConversionReportTime supports the '=' operator.
For example:
	
	SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'

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.
StartDate Date Metric report start date.
EndDate Date Metric report end date.
Granularity String Granularity

The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns

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

Name Type Description
ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime String The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

AdAccountAnalyticsReport

Get the ad account analytics report

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • 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 '=,IN' operator.
  • CampaignStatuses supports the '=,IN' operator.
  • CampaignObjectiveTypes supports the '=' operator.
  • AdGroupIds supports the '=,IN' operator.
  • AdGroupStatuses supports the '=' operator.
  • AdIds supports the '=,IN' operator.
  • AdStatuses supports the '=' operator.
  • ProductGroupIds supports the '=,IN' operator.
  • ProductGroupStatuses supports the '=,IN' operator.
  • TargetingTypes supports the '=,IN' operator.
  • ProductItemIds supports the '=,IN' operator.
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.

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

Pseudo-Columns

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

Name Type Description
ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

The default value is 30.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

The default value is 30.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

The default value is 30.

ConversionReportTime String The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

The default value is TIME_OF_AD_ACTION.

AttributionTypes String List of types of attribution for the conversion report

The allowed values are INDIVIDUAL, HOUSEHOLD.

CampaignIds String Id of the campaign.
CampaignStatuses String List of status values for filtering

The allowed values are RUNNING, PAUSED, NOT_STARTED, COMPLETED, ADVERTISER_DISABLED, ARCHIVED.

CampaignObjectiveTypes String List of status values for filtering

The allowed values are AWARENESS, CONSIDERATION, VIDEO_VIEW WEB_CONVERSION, CATALOG_SALES, WEB_SESSIONS.

AdGroupIds String Id of the ad group.
AdGroupStatuses String Id of the ad group.

The allowed values are AWARENESS, CONSIDERATION, VIDEO_VIEW WEB_CONVERSION, CATALOG_SALES, WEB_SESSIONS.

AdIds String List of ad ids
AdStatuses String List of values for filtering.

The allowed values are APPROVED, AUSED, PENDING, REJECTED, ADVERTISER_DISABLED, ARCHIVED.

ProductGroupIds String List of product group ids.
ProductGroupStatuses String List of product item ids.

The allowed values are RUNNING, PAUSED, EXCLUDED, ARCHIVED.

TargetingTypes String Targeting type

The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, GEO, AGE_BUCKET, REGION.

AdsAnalyticsMetricsFilter String List of metrics filters
ProductItemIds String List of product item ids.
AdsAnalyticsMetricsFilter String List of metrics filters

Pinterest Connector for CData Sync

AdAccounts

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

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • IncludeSharedAccounts 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 Include shared ad accounts

Pinterest Connector for CData Sync

AdAccountTargetingAnalytics

Get targeting analytics for an ad account.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • TargetingTypes supports the '=' operator.
For example:
	
	SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451'

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.
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 List of types of attribution for the conversion report.

The allowed values are INDIVIDUAL, HOUSEHOLD.

ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

AdAnalytics

Get analytics for the ads in the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • AdId supports the '=,IN' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • ConversionReportTime supports the '=' operator.
For example:
	
	SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'

Columns

Name Type References Description
AdId String

Ads.Id

Id of the ad
AdAccountId String

AdAccounts.Id

Id of the ad account
Date Date Current metrics date. Only returned when granularity is a time-based value.
CampaignEntityStatus String Status of the campaign.
AdGroupEntityStatus String Status of the ad group.
SpendInDollar Double Total spend in dollars.
EcpcInDollar Double Ecpc in dollars.
Ctr Double Ctr.
Ectr Double Ectr.
EcpeInDollar Double Ecpe in Dollars.
EngagementRate Double The engagement rate.
EengagementRate Double E Engagement rate.
RepinRate Double The repin rate.
Ctr2 Double Ctr2
CpmInDollar Double Cpm in Dollars.
WebCheckoutCostPerAction Double Web checkout cost per action.
WebCheckoutRoas Double Web checkout roas
PageVisitCostPerAction Double Page visit cost per action.
PageVisitRoas Double Page visit roas.
CheckoutRoas Double Checkout roas.
Video3secViews2 Integer Videos with at least 3 seconds of viewing.
VideoP100Complete2 Integer Videos 100 percent complete
VideoP0Combined2 Integer Videos 0 percent combined viewed.
VideoP25Combined2 Integer Videos 25 percent combined viewed.
VideoP50Combined2 Integer Video 50 percent combined viewed.
VideoP75Combined2 Integer Video 75 percent combined viewed.
VideoP95Combined2 Integer Video 95 percent combined viewed.
VideoMrcViews2 Integer Video Mrc Views.
EcpvInDollar Double Ecpv in dollars.
EcpcvInDollar Double E Cpcv in Dollars
EcpcvP95InDollar Double E Cpcv 95 percent in Dollars.
TotalClickthrough Integer Total Clickthrough.
TotalImpressionFrequency Double Total Impression Frequency.
TotalEngagementSignup Integer Total Engagement Signup.
TotalEngagementCheckout Integer Total Engagement Checkout.
TotalClickSignup Integer Total Click Signup.
TotalClickCheckout Integer Total Click Checkout.
TotalViewSignup Integer Total View Signup.
TotalViewCheckout Integer Total View Checkout.
TotalConversions Integer Total Conversions.
TotalEngagementSignupValueInMicroDollar Double Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar Double Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar Double Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar Double Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar Double Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar Double Total View Checkout Value In Micro Dollar.
TotalPageVisit Integer Total Page Visit.
TotalSignup Integer Total Signup.
TotalCheckout Integer Total Checkout.
TotalSignupValueInMicroDollar Double Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar Double Total Checkout Value In Micro Dollar.
TotalVideo3secViews Integer Total Video 3 second Views.
TotalVideoP100Complete Integer Total Video 100 percent Complete.
TotalVideoP0Combined Integer Total Video 0 percent Combined.
TotalVideoP25Combined Integer Total Video 25 percent Combined.
TotalVideoP50Combined Integer Total Video 50 percent Combined.
TotalVideoP75Combined Integer Total Video 75 percent Combined.
TotalVideoP95Combined Integer Total Video 95 percent Combined.
TotalVideoMrcViews Integer Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond Integer Total Video Avg Watchtime In Seconds.
TotalRepinRate Double Total Repin Rate.
TotalWebCheckout Integer Total Web Checkout.
TotalWebCheckoutValueInMicroDollar Double Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout Integer Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar Double Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout Integer Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar Double Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout Integer Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar Double Total Web View Checkout Value In Micro Dollar.
Clickthrough1 Integer Clickthrough1.
Clickthrough1Gross Integer Clickthrough1 Gross.
Impression1 Integer Impression1.
Impression1Gross Integer Impression1 Gross.
CampaignId String

Campaigns.Id

Id of the Campaign.
AdvertiserId String Id of the ad account
AdGroupId String

AdGroups.Id

Id of the ad group.
CampaignDailySpendCap Integer Campaign daily spend cap.
CampaignLifetimeSpendCap Integer Campaign Lifetime Spend Cap.
CampaignName String Name of the Campaign
Clickthrough2 Integer Clickthrough2.
CpcInMicroDollar Decimal Cpc In MicroDollar.
CpmInMicroDollar Decimal Cpm In MicroDollar.
EcpcInMicroDollar Decimal Ecpc In MicroDollar.
EcpmInMicroDollar Decimal Ecpm In MicroDollar.
Engagement1 Integer Engagement1.
Engagement2 Integer Engagement2.
IdeaPinProductTagVisit1 Integer Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2 Integer Idea Pin Product Tag Visit2.
Impression2 Integer Impression2.
InAppCheckoutCostPerAction Double In App Checkout Cost Per Action.
OutboundClick1 Integer Outboundclick1.
OutboundClick2 Integer Outboundclick2.
PaidImpression Integer PaidImpression.
PinId String

Pins.Id

Id of the Pins.
Repin1 Integer Repin1.
Repin2 Integer Repin2.
SpendInMicroDollar Decimal Total spend in dollars.
TotalClickAddToCart Integer Total click add to cart.
TotalClickLead Integer Total click lead.
TotalCustom Integer Total custom.
TotalEngagement Integer Total Engagement.
TotalEngagementLead Integer Total Engagement Lead.
TotalIdeaPinProductTagVisit Integer Total Idea Pin Product Tag Visit.
TotalImpressionUser Integer Total Impression User.
TotalLead Integer Total Lead.
TotalOfflineCheckout Integer Total offline checkout.
TotalViewAddToCart Integer Total view add to cart.
TotalViewLead Integer Total view Lead.
TotalWebSessions Integer Total web sessions.
VideoLength Integer VideoLength.
WebSessions1 Integer WebSessions1.
WebSessions2 Integer WebSessions2.
StartDate Date Metric report start date.
EndDate Date Metric report end date.
Granularity String Granularity

The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns

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

Name Type Description
ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime String The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

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.
StartDate Date Metric report start date.
EndDate Date Metric report end date.
Granularity String Granularity

The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns

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

Name Type Description
ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime String The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

AdGroupAnalytics

Get analytics for the ad groups in the specified AdAccountId

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • AdGroupId supports the '=,IN' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • ConversionReportTime supports the '=' operator.
For example:
	
	SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'

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.
StartDate Date Metric report start date.
EndDate Date Metric report end date.
Granularity String Granularity

The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns

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

Name Type Description
ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

AdGroups

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

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • Id supports the '=,IN' operator.
  • 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.
BudgetInMicroCurrency Integer Budget in micro currency.
BudgetType String Budget type
ConversionLearningModeType String oCPM learn mode
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
PlacementGroup String PlacementGroup
StartTime Datetime Ad group start time
Status String Ad group/entity status.

The allowed values are ACTIVE, PAUSED, ARCHIVED.

SummaryStatus String Ad group summary status.
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.

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 Return interests as text names and not topic IDs?

Pinterest Connector for CData Sync

AdGroupTargetingAnalytics

Get targeting analytics for one or more ad groups.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • AdGroupId supports the '=,IN' operators.
  • TargetingType supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • ConversionReportTime supports the '=' operator.
For example:
	
	SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'

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.
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 List of types of attribution for the conversion report.

The allowed values are INDIVIDUAL, HOUSEHOLD.

ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

Ads

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

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • Id supports the '=,IN' operator.
  • AdGroupId supports the '=,IN' operator.
  • CampaignId supports the '=,IN' operator.
  • 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
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
Status String Entity status

The allowed values are ACTIVE, PAUSED, ARCHIVED.

SummaryStatus String Ad summary status.
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.

Pinterest Connector for CData Sync

AdsTargetingAnalytics

Get targeting analytics for one or more ads.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • TargetingTypes supports the '=' operator.
  • AdId supports the '=' operator.
For example:
	
	SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451'

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.
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 List of types of attribution for the conversion report.

The allowed values are INDIVIDUAL, HOUSEHOLD.

ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

Boards

Get a list of the boards owned by the User

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

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

Pinterest Connector for CData Sync

BoardSections

Get a list of the boards owned by the User

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

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

Pinterest Connector for CData Sync

Campaigns

Get account information for the operation user_account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • Id supports the '=,IN' operator.
  • 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.
OrderLineId String Order line ID that appears on the invoice.
Status String Entity status.

The allowed values are ACTIVE, PAUSED, ARCHIVED.

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.
IsFlexibleDailyBudgets Boolean Is Flexible Daily Budgets.
IsCampaignBudgetOptimization Boolean Is Campaign Budget Optimization.

Pinterest Connector for CData Sync

CampaignTargetingAnalytics

Get targeting analytics for one or more campaign.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • TargetingTypes supports the '=' operator.
  • CampaignId supports the '=' operator.
For example:
	
	SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451'
    SELECT * FROM CampaignTargetingAnalytics WHERE CampaignId = '451'

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, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION.

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.
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 List of types of attribution for the conversion report.

The allowed values are INDIVIDUAL, HOUSEHOLD.

ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

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 Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • 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.
Media String Media for the Pin.
Title String Title of the Pin.
PinMetrics String Pin metrics of the Pin.

Pinterest Connector for CData Sync

ProductGroupAnalytics

Get targeting analytics for one or more campaign.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • AdAccountId supports the '=' operator.
  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • Granularity supports the '=' operator.
  • ClickWindowDays supports the '=' operator.
  • EngagementWindowDays supports the '=' operator.
  • ViewWindowDays supports the '=' operator.
  • TargetingTypes supports the '=' operator.
  • ProductGroupId supports the '=' operator.
For example:
	
	SELECT * FROM ProductGroupAnalytics WHERE AdAccountId = '3457832451'
    SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451'

Columns

Name Type References Description
AdAccountId String

AdAccounts.Id

Unique identifier of an ad account.
ProductGroupId String Product group Ids .
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.
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 List of types of attribution for the conversion report.

The allowed values are INDIVIDUAL, HOUSEHOLD.

ClickWindowDays Integer Number of days to use as the conversion attribution window for a pin click action.

The allowed values are 1, 7, 30, 60.

EngagementWindowDays Integer Number of days to use as the conversion attribution window for an engagement action.

The allowed values are 1, 7, 30, 60.

ViewWindowDays Integer Number of days to use as the conversion attribution window for a view action.

The allowed values are 1, 7, 30, 60.

ConversionReportTime Integer The date by which the conversion metrics returned from this endpoint will be reported.

The allowed values are TIME_OF_AD_ACTION, TIME_OF_CONVERSION.

Pinterest Connector for CData Sync

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.

Pinterest Connector for CData Sync

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.

Pinterest Connector for CData Sync

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.

Pinterest Connector for CData Sync

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.

Pinterest Connector for CData Sync

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.

Pinterest Connector for CData Sync

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

Pinterest Connector for CData Sync

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 Sync App.

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

Pinterest Connector for CData Sync

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 Sync App.

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 Specify an ad_account_id to use the owner of that ad_account as the operation user_account.

Pinterest Connector for CData Sync

UserAccountDailyMetrics

Get Daily Metric of User Account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • 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'

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 Filter on Pins that match your claimed domain.

The allowed values are OTHER, CLAIMED, BOTH.

The default value is BOTH.

PinFormat String Pin formats to get data for, default is all.

The allowed values are ALL, PRODUCT, REGULAR, VIDEO.

The default value is ALL.

AppTypes String Apps or devices to get data for, default is all.

The allowed values are ALL, MOBILE, TABLET, WEB.

The default value is ALL.

MetricTypes String Metric types to get data for, default is all.

The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL.

The default value is ALL.

SplitField String How to split the data into groups. Not including this param means data won't be split.

The allowed values are NO_SPLIT, APP_TYPE, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT.

The default value is NO_SPLIT.

AdAccountID String Unique identifier of an ad account.

Pinterest Connector for CData Sync

UserAccountSummaryMetrics

Get Summary Metric of User Account

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • 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'

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 Filter on Pins that match your claimed domain.

The allowed values are OTHER, CLAIMED, BOTH.

The default value is BOTH.

PinFormat String Pin formats to get data for, default is all.

The allowed values are ALL, PRODUCT, REGULAR, VIDEO.

The default value is ALL.

AppTypes String Apps or devices to get data for, default is all.

The allowed values are ALL, MOBILE, TABLET, WEB.

The default value is ALL.

MetricTypes String Metric types to get data for, default is all.

The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE, ALL.

The default value is ALL.

SplitField String How to split the data into groups. Not including this param means data won't be split.

The allowed values are NO_SPLIT, APP_TYPE, CONTENT_TYPE, OWNED_CONTENT, SOURCE, PIN_FORMAT, CONVERSION_TYPE, ATTRIBUTION_EVENT.

The default value is NO_SPLIT.

AdAccountID String Unique identifier of an ad account.

Pinterest Connector for CData Sync

UserAccountTopVideoPinAnalytics

Get analytics data about a user's top pins.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • 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'

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.
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 Get metrics for pins created in the last
NumOfPins Integer Number of pins to include, default is 10. Max is 50.
MetricTypes String Metric types to get data for, default is all.

The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE.

AppType String Apps or devices to get data for, default is all.

The allowed values are ALL, MOBILE, TABLET, WEB.

The default value is ALL.

PiFormat String Pin formats to get data for, default is all.

The allowed values are ALL, PRODUCT, REGULAR, VIDEO.

The default value is ALL.

FromClaimedContent String Filter on Pins that match your claimed domain.

The allowed values are OTHER, CLAIMED, BOTH.

The default value is BOTH.

Pinterest Connector for CData Sync

UserTopPinAnalytics

Get analytics data about a user's top pins.

Table Specific Information

Select

The Sync App will use the Pinterest API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Sync App.

  • StartDate supports the '=' operator.
  • EndDate supports the '=' operator.
  • 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'

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.

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 Get metrics for pins created in the last
NumOfPins Integer Number of pins to include, default is 10. Max is 50.
MetricTypes String Metric types to get data for, default is all.

The allowed values are ENGAGEMENT, ENGAGEMENT_RATE, IMPRESSION, OUTBOUND_CLICK, OUTBOUND_CLICK_RATE, PIN_CLICK, PIN_CLICK_RATE, SAVE, SAVE_RATE.

AppType String Apps or devices to get data for, default is all.

The allowed values are ALL, MOBILE, TABLET, WEB.

The default value is ALL.

PiFormat String Pin formats to get data for, default is all.

The allowed values are ALL, PRODUCT, REGULAR, VIDEO.

The default value is ALL.

FromClaimedContent String Filter on Pins that match your claimed domain.

The allowed values are OTHER, CLAIMED, BOTH.

The default value is BOTH.

Pinterest Connector for CData Sync

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Connection


PropertyDescription
AdAccountIdUnique identifier of an Ad Account.

OAuth


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.

SSL


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

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous


PropertyDescription
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Pinterest Connector for CData Sync

Connection

This section provides a complete list of the Connection properties you can configure in the connection string for this provider.


PropertyDescription
AdAccountIdUnique identifier of an Ad Account.
Pinterest Connector for CData Sync

AdAccountId

Unique identifier of an Ad Account.

Remarks

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

Pinterest Connector for CData Sync

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.


PropertyDescription
OAuthClientIdThe client Id assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
Pinterest Connector for CData Sync

OAuthClientId

The client Id assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

Pinterest Connector for CData Sync

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

Pinterest Connector for CData Sync

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.
Pinterest Connector for CData Sync

SSLServerCert

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

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.

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

Pinterest Connector for CData Sync

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.
Pinterest Connector for CData Sync

FirewallType

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type Default Port Description
TUNNEL 80 When this is set, the Sync App opens a connection to Pinterest and traffic flows back and forth through the proxy.
SOCKS4 1080 When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5 1080 When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

Pinterest Connector for CData Sync

FirewallServer

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

Pinterest Connector for CData Sync

FirewallPort

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

Pinterest Connector for CData Sync

FirewallUser

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

Pinterest Connector for CData Sync

FirewallPassword

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

Pinterest Connector for CData Sync

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.


PropertyDescription
ProxyAutoDetectThis indicates whether to use the system proxy settings or not.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Pinterest Connector for CData Sync

ProxyAutoDetect

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

Pinterest Connector for CData Sync

ProxyServer

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

Pinterest Connector for CData Sync

ProxyPort

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

Pinterest Connector for CData Sync

ProxyAuthScheme

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

  • BASIC: The Sync App performs HTTP BASIC authentication.
  • DIGEST: The Sync App performs HTTP DIGEST authentication.
  • NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
  • PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

Pinterest Connector for CData Sync

ProxyUser

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

Pinterest Connector for CData Sync

ProxyPassword

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

Pinterest Connector for CData Sync

ProxySSLType

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTODefault setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYSThe connection is always SSL enabled.
NEVERThe connection is not SSL enabled.
TUNNELThe connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

Pinterest Connector for CData Sync

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

Pinterest Connector for CData Sync

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.


PropertyDescription
LogModulesCore modules to be included in the log file.
Pinterest Connector for CData Sync

LogModules

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

Pinterest Connector for CData Sync

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Pinterest Connector for CData Sync

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Pinterest Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Linux ~/.config

Pinterest Connector for CData Sync

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Pinterest Connector for CData Sync

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Pinterest Connector for CData Sync

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Pinterest Connector for CData Sync

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.


PropertyDescription
MaxRowsLimits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
OtherThese hidden properties are used only in specific use cases.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViewsA filepath pointing to the JSON configuration file containing your custom views.
Pinterest Connector for CData Sync

MaxRows

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Pinterest Connector for CData Sync

Other

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSizeSets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMTDetermines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filenameRecords the underlying socket data transfer to the specified file.

Pinterest Connector for CData Sync

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Pinterest Connector for CData Sync

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Pinterest Connector for CData Sync

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom 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)"
	}
}
Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json
Note that the specified path is not embedded in quotation marks.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839