Pinterest Connection Details¶

Introduction¶

Connector Version

This documentation is based on version 23.0.8895 of the connector.

Get Started¶

Pinterest Version Support

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

Establish a Connection¶

Connect to Pinterest¶

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

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

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

For information about how to create a custom OAuth application, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Pinterest, see Connection.

Desktop Applications¶

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

Get and refresh the OAuth access token:

InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
OAuthClientId: The client ID assigned when you registered your application.
OAuthClientSecret: The client secret that was assigned when you registered your application.
CallbackURL: The redirect URI that was defined when you registered your application.

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

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

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

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

Automatic refresh of the OAuth access token:

To have the connector automatically refresh the OAuth access token:

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 connector to save the OAuth values, which persist across connections.
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.

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

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

Create a Custom OAuth Application¶

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

Procedure¶

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

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

Record these settings for future use.

Important Notes¶

Configuration Files and Their Paths¶

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

Data Model¶

Overview

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

Key Features

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

Views

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

Views¶

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Pinterest Connector Views¶

Name	Description
`AdAccountAnalytics`	Get analytics for the specified AdAccountId
`AdAccountAnalyticsReport`	Get the ad account analytics report
`AdAccounts`	Get a list of the ad_accounts that the User has access to.
`AdAccountTargetingAnalytics`	Get targeting analytics for an ad account.
`AdAnalytics`	Get analytics for the ads in the specified AdAccountId
`AdCampaignAnalytics`	Get analytics for the specified campaigns in the specified AdAccountId
`AdGroupAnalytics`	Get analytics for the ad groups in the specified AdAccountId
`AdGroups`	Get a list of the ad_accounts that the User has access to.
`AdGroupTargetingAnalytics`	Get targeting analytics for one or more ad groups.
`Ads`	Get a list of the ad_accounts that the User has access to.
`AdsTargetingAnalytics`	Get targeting analytics for one or more ads.
`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.

AdAccountAnalytics¶

Get analytics for the specified AdAccountId

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

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

Pseudo-Columns¶

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

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

AdAccountAnalyticsReport¶

Get the ad account analytics report

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdAccountAnalyticsReport WHERE AdAccountId = '3457832451' AND Level = 'advertiser'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Id of the ad account.
`StartDate`	`Date`		Metric report start date.
`EndDate`	`Date`		Metric report end date.
`Granularity`	`String`		Granularity The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.
`Level`	`String`		Level of the report. The allowed values are ADVERTISER, ADVERTISER_TARGETING, CAMPAIGN, CAMPAIGN_TARGETING, AD_GROUP, AD_GROUP_TARGETING, PIN_PROMOTION, PIN_PROMOTION_TARGETING, KEYWORD, PRODUCT_GROUP, PRODUCT_GROUP_TARGETING, PRODUCT_ITEM. 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`
`ViewWindowDays`	`Integer`
`EngagementWindowDays`	`Integer`
`ConversionReportTime`	`String`
`AttributionTypes`	`String`
`CampaignIds`	`String`
`CampaignStatuses`	`String`
`CampaignObjectiveTypes`	`String`
`AdGroupIds`	`String`
`AdGroupStatuses`	`String`
`AdIds`	`String`
`AdStatuses`	`String`
`ProductGroupIds`	`String`
`ProductGroupStatuses`	`String`
`TargetingTypes`	`String`
`AdsAnalyticsMetricsFilter`	`String`
`ProductItemIds`	`String`
`AdsAnalyticsMetricsFilter`	`String`

AdAccounts¶

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

Table Specific Information¶

Select¶

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

IncludeSharedAccounts supports the = operator.

For example:

SELECT * FROM AdAccounts

Columns¶

Name	Type	Description
`Id [KEY]`	`String`	Id of the Ad Account.
`Name`	`String`	Name of the Ad Account.
`OwnerUsername`	`String`	Owner Usernameof the Ad Account.
`Country`	`String`	Country of the ad account.
`Currency`	`String`	Currency of the ad account.
`OwnerId`	`String`	Owner UserId of the ad account.
`CreatedTime`	`Datetime`	Created Time of the ad account.
`UpdatedTime`	`Datetime`	Updated Time of the ad account.
`Permissions`	`String`	Permissions of the ad account.

Pseudo-Columns¶

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

Name	Type	Description
`IncludeSharedAccounts`	`Boolean`

AdAccountTargetingAnalytics¶

Get targeting analytics for an ad account.

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdAccountTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`AdGroupId`	`String`	AdGroups.Id	Id of the ad group.
`TargetingType`	`String`		Targeting type. The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, 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`
`ClickWindowDays`	`Integer`
`EngagementWindowDays`	`Integer`
`ViewWindowDays`	`Integer`
`ConversionReportTime`	`Integer`

AdAnalytics¶

Get analytics for the ads in the specified AdAccountId

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' AND AdId = '3457862457'
SELECT * FROM AdAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

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

Pseudo-Columns¶

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

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

AdCampaignAnalytics¶

Get analytics for the specified campaigns in the specified AdAccountId

Columns¶

Name	Type	References	Description
`CampaignId`	`String`	Campaigns.Id	Id of the campaign.
`AdAccountId`	`String`	AdAccounts.Id	Id of the ad account.
`Date`	`Date`		Date the analytics row covers.
`CampaignEntityStatus`	`String`		Status of the campaign.
`AdGroupEntityStatus`	`String`		Status of the ad group.
`SpendInDollar`	`Double`		Total spend in dollars.
`EcpcInDollar`	`Double`		Ecpc in dollars.
`Ctr`	`Double`		Ctr.
`Ectr`	`Double`		Ectr.
`EcpeInDollar`	`Double`		Ecpe in Dollars.
`EngagementRate`	`Double`		The engagement rate.
`EengagementRate`	`Double`		E Engagement rate.
`RepinRate`	`Double`		The repin rate.
`Ctr2`	`Double`		Ctr2
`CpmInDollar`	`Double`		Cpm in Dollars.
`WebCheckoutCostPerAction`	`Double`		Web checkout cost per action.
`WebCheckoutRoas`	`Double`		Web checkout roas
`PageVisitCostPerAction`	`Double`		Page visit cost per action.
`PageVisitRoas`	`Double`		Page visit roas.
`CheckoutRoas`	`Double`		Checkout roas.
`Video3secViews2`	`Integer`		Videos with at least 3 seconds of viewing.
`VideoP100Complete2`	`Integer`		Videos 100 percent complete
`VideoP0Combined2`	`Integer`		Videos 0 percent combined viewed.
`VideoP25Combined2`	`Integer`		Videos 25 percent combined viewed.
`VideoP50Combined2`	`Integer`		Video 50 percent combined viewed.
`VideoP75Combined2`	`Integer`		Video 75 percent combined viewed.
`VideoP95Combined2`	`Integer`		Video 95 percent combined viewed.
`VideoMrcViews2`	`Integer`		Video Mrc Views.
`EcpvInDollar`	`Double`		Ecpv in dollars.
`EcpcvInDollar`	`Double`		E Cpcv in Dollars
`EcpcvP95InDollar`	`Double`		E Cpcv 95 percent in Dollars.
`TotalClickthrough`	`Integer`		Total Clickthrough.
`TotalImpressionFrequency`	`Double`		Total Impression Frequency.
`TotalEngagementSignup`	`Integer`		Total Engagement Signup.
`TotalEngagementCheckout`	`Integer`		Total Engagement Checkout.
`TotalClickSignup`	`Integer`		Total Click Signup.
`TotalClickCheckout`	`Integer`		Total Click Checkout.
`TotalViewSignup`	`Integer`		Total View Signup.
`TotalViewCheckout`	`Integer`		Total View Checkout.
`TotalConversions`	`Integer`		Total Conversions.
`TotalEngagementSignupValueInMicroDollar`	`Double`		Total Engagement Signup Value In Micro Dollar.
`TotalEngagementCheckoutValueInMicroDollar`	`Double`		Total Engagement Checkout Value In Micro Dollar.
`TotalClickSignupValueInMicroDollar`	`Double`		Total Click Signup Value In Micro Dollar.
`TotalClickCheckoutValueInMicroDollar`	`Double`		Total Click Checkout Value In Micro Dollar.
`TotalViewSignupValueInMicroDollar`	`Double`		Total View Signup Value In Micro Dollar.
`TotalViewCheckoutValueInMicroDollar`	`Double`		Total View Checkout Value In Micro Dollar.
`TotalPageVisit`	`Integer`		Total Page Visit.
`TotalSignup`	`Integer`		Total Signup.
`TotalCheckout`	`Integer`		Total Checkout.
`TotalSignupValueInMicroDollar`	`Double`		Total Signup Value In Micro Dollar.
`TotalCheckoutValueInMicroDollar`	`Double`		Total Checkout Value In Micro Dollar.
`TotalVideo3secViews`	`Integer`		Total Video 3 second Views.
`TotalVideoP100Complete`	`Integer`		Total Video 100 percent Complete.
`TotalVideoP0Combined`	`Integer`		Total Video 0 percent Combined.
`TotalVideoP25Combined`	`Integer`		Total Video 25 percent Combined.
`TotalVideoP50Combined`	`Integer`		Total Video 50 percent Combined.
`TotalVideoP75Combined`	`Integer`		Total Video 75 percent Combined.
`TotalVideoP95Combined`	`Integer`		Total Video 95 percent Combined.
`TotalVideoMrcViews`	`Integer`		Total Video Mrc Views.
`TotalVideoAvgWatchtimeInSecond`	`Integer`		Total Video Avg Watchtime In Seconds.
`TotalRepinRate`	`Double`		Total Repin Rate.
`TotalWebCheckout`	`Integer`		Total Web Checkout.
`TotalWebCheckoutValueInMicroDollar`	`Double`		Total Web Checkout Value In Micro Dollar.
`TotalWebClickCheckout`	`Integer`		Total Web Click Checkout.
`TotalWebClickCheckoutValueInMicroDollar`	`Double`		Total Web Click Checkout Value In Micro Dollar.
`TotalWebEngagementCheckout`	`Integer`		Total Web Engagement Checkout.
`TotalWebEngagementCheckoutValueInMicroDollar`	`Double`		Total Web Engagement Checkout Value In Micro Dollar.
`TotalWebViewCheckout`	`Integer`		Total Web View Checkout.
`TotalWebViewCheckoutValueInMicroDollar`	`Double`		Total Web View Checkout Value In Micro Dollar.
`Clickthrough1`	`Integer`		Clickthrough1.
`Clickthrough1Gross`	`Integer`		Clickthrough1 Gross.
`Impression1`	`Integer`		Impression1.
`Impression1Gross`	`Integer`		Impression1 Gross.
`AdId`	`String`	Ads.Id	Id of the Ad.
`StartDate`	`Date`		Metric report start date.
`EndDate`	`Date`		Metric report end date.
`Granularity`	`String`		Granularity The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns¶

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

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

AdGroupAnalytics¶

Get analytics for the ad groups in the specified AdAccountId

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' AND AdGroupId = '3457862457'
SELECT * FROM AdGroupAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdGroupId`	`String`	AdGroups.Id	Id of the ad group.
`AdAccountId`	`String`	AdAccounts.Id	Id of the ad account.
`Date`	`Date`		Date the analytics row covers.
`CampaignEntityStatus`	`String`		Status of the campaign.
`AdGroupEntityStatus`	`String`		Status of the ad group.
`SpendInDollar`	`Double`		Total spend in dollars.
`EcpcInDollar`	`Double`		Ecpc in dollars.
`Ctr`	`Double`		Ctr.
`Ectr`	`Double`		Ectr.
`EcpeInDollar`	`Double`		Ecpe in Dollars.
`EngagementRate`	`Double`		The engagement rate.
`EengagementRate`	`Double`		E Engagement rate.
`RepinRate`	`Double`		The repin rate.
`Ctr2`	`Double`		Ctr2
`CpmInDollar`	`Double`		Cpm in Dollars.
`WebCheckoutCostPerAction`	`Double`		Web checkout cost per action.
`WebCheckoutRoas`	`Double`		Web checkout roas
`PageVisitCostPerAction`	`Double`		Page visit cost per action.
`PageVisitRoas`	`Double`		Page visit roas.
`CheckoutRoas`	`Double`		Checkout roas.
`Video3secViews2`	`Integer`		Videos with at least 3 seconds of viewing.
`VideoP100Complete2`	`Integer`		Videos 100 percent complete
`VideoP0Combined2`	`Integer`		Videos 0 percent combined viewed.
`VideoP25Combined2`	`Integer`		Videos 25 percent combined viewed.
`VideoP50Combined2`	`Integer`		Video 50 percent combined viewed.
`VideoP75Combined2`	`Integer`		Video 75 percent combined viewed.
`VideoP95Combined2`	`Integer`		Video 95 percent combined viewed.
`VideoMrcViews2`	`Integer`		Video Mrc Views.
`EcpvInDollar`	`Double`		Ecpv in dollars.
`EcpcvInDollar`	`Double`		E Cpcv in Dollars
`EcpcvP95InDollar`	`Double`		E Cpcv 95 percent in Dollars.
`TotalClickthrough`	`Integer`		Total Clickthrough.
`TotalImpressionFrequency`	`Double`		Total Impression Frequency.
`TotalEngagementSignup`	`Integer`		Total Engagement Signup.
`TotalEngagementCheckout`	`Integer`		Total Engagement Checkout.
`TotalClickSignup`	`Integer`		Total Click Signup.
`TotalClickCheckout`	`Integer`		Total Click Checkout.
`TotalViewSignup`	`Integer`		Total View Signup.
`TotalViewCheckout`	`Integer`		Total View Checkout.
`TotalConversions`	`Integer`		Total Conversions.
`TotalEngagementSignupValueInMicroDollar`	`Double`		Total Engagement Signup Value In Micro Dollar.
`TotalEngagementCheckoutValueInMicroDollar`	`Double`		Total Engagement Checkout Value In Micro Dollar.
`TotalClickSignupValueInMicroDollar`	`Double`		Total Click Signup Value In Micro Dollar.
`TotalClickCheckoutValueInMicroDollar`	`Double`		Total Click Checkout Value In Micro Dollar.
`TotalViewSignupValueInMicroDollar`	`Double`		Total View Signup Value In Micro Dollar.
`TotalViewCheckoutValueInMicroDollar`	`Double`		Total View Checkout Value In Micro Dollar.
`TotalPageVisit`	`Integer`		Total Page Visit.
`TotalSignup`	`Integer`		Total Signup.
`TotalCheckout`	`Integer`		Total Checkout.
`TotalSignupValueInMicroDollar`	`Double`		Total Signup Value In Micro Dollar.
`TotalCheckoutValueInMicroDollar`	`Double`		Total Checkout Value In Micro Dollar.
`TotalVideo3secViews`	`Integer`		Total Video 3 second Views.
`TotalVideoP100Complete`	`Integer`		Total Video 100 percent Complete.
`TotalVideoP0Combined`	`Integer`		Total Video 0 percent Combined.
`TotalVideoP25Combined`	`Integer`		Total Video 25 percent Combined.
`TotalVideoP50Combined`	`Integer`		Total Video 50 percent Combined.
`TotalVideoP75Combined`	`Integer`		Total Video 75 percent Combined.
`TotalVideoP95Combined`	`Integer`		Total Video 95 percent Combined.
`TotalVideoMrcViews`	`Integer`		Total Video Mrc Views.
`TotalVideoAvgWatchtimeInSecond`	`Integer`		Total Video Avg Watchtime In Seconds.
`TotalRepinRate`	`Double`		Total Repin Rate.
`TotalWebCheckout`	`Integer`		Total Web Checkout.
`TotalWebCheckoutValueInMicroDollar`	`Double`		Total Web Checkout Value In Micro Dollar.
`TotalWebClickCheckout`	`Integer`		Total Web Click Checkout.
`TotalWebClickCheckoutValueInMicroDollar`	`Double`		Total Web Click Checkout Value In Micro Dollar.
`TotalWebEngagementCheckout`	`Integer`		Total Web Engagement Checkout.
`TotalWebEngagementCheckoutValueInMicroDollar`	`Double`		Total Web Engagement Checkout Value In Micro Dollar.
`TotalWebViewCheckout`	`Integer`		Total Web View Checkout.
`TotalWebViewCheckoutValueInMicroDollar`	`Double`		Total Web View Checkout Value In Micro Dollar.
`Clickthrough1`	`Integer`		Clickthrough1.
`Clickthrough1Gross`	`Integer`		Clickthrough1 Gross.
`Impression1`	`Integer`		Impression1.
`Impression1Gross`	`Integer`		Impression1 Gross.
`Impression2`	`Integer`		Impression2.
`TotalImpressionUser`	`Integer`		Total ImpressionUser.
`CampaignDailySpendCap`	`Integer`		Campaign Daily Spend Cap.
`CampaignLifetimeSpendCap`	`Integer`		Campaign Lifetime Spend Cap.
`Clickthrough2`	`Integer`		Clickthrough2.
`CpcInMicroDollar`	`Double`		Cpc In MicroDollar.
`CpmInMicroDollar`	`Double`		Cpm In MicroDollar.
`EcpcInMicroDollar`	`Double`		Ecpc In MicroDollar.
`EcpmInMicroDollar`	`Double`		Ecpm In MicroDollar.
`Engagement1`	`Integer`		Engagement1.
`Engagement2`	`Integer`		Engagement2.
`IdeaPinProductTagVisit1`	`Integer`		Idea Pin Product Tag Visit1.
`IdeaPinProductTagVisit2`	`Integer`		Idea Pin Product Tag Visit2.
`InAppCheckoutCostPerAction`	`Double`		In App Checkout Cost Per Action.
`OutboundClick1`	`Integer`		Outboundclick1.
`OutboundClick2`	`Integer`		Outboundclick2.
`PaidImpression`	`Integer`		PaidImpression.
`Repin1`	`Integer`		Repin1.
`Repin2`	`Integer`		Repin2.
`SpendInMicroDollar`	`Double`		Spend In MicroDollar.
`TotalClickAddToCart`	`Integer`		Total Click Add To Cart.
`TotalClickLead`	`Integer`		Total ClickLead.
`TotalCustom`	`Integer`		Total Custom.
`TotalEngagement`	`Integer`		Total Engagement.
`TotalEngagementLead`	`Integer`		Total Engagement Lead.
`TotalIdeaPinProductTagVisit`	`Integer`		Total Idea Pin Product Tag Visit.
`TotalLead`	`Integer`		Total Lead.
`TotalOfflineCheckout`	`Integer`		Total Offline Checkout.
`TotalViewAddToCart`	`Integer`		Total View Add To Cart.
`TotalViewLead`	`Integer`		Total View Lead.
`TotalWebSessions`	`Integer`		Total Web Sessions.
`VideoLength`	`Integer`		VideoLength.
`WebSessions1`	`Integer`		WebSessions1.
`WebSessions2`	`Integer`		WebSessions2.
`AdId`	`String`	Ads.Id	Id of the Ad.
`CampaignId`	`String`	Campaigns.Id	Id of the Campaign.
`StartDate`	`Date`		Metric report start date.
`EndDate`	`Date`		Metric report end date.
`Granularity`	`String`		Granularity The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns¶

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

Name	Type	Description
`ClickWindowDays`	`Integer`
`EngagementWindowDays`	`Integer`
`ViewWindowDays`	`Integer`
`ConversionReportTime`	`Integer`

AdGroups¶

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

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdGroups WHERE AdAccountId = '3457832451'

Columns¶

Name	Type	References	Description
`Id [KEY]`	`String`		Advertiser ID.
`AdAccountId`	`String`	AdAccounts.Id	Ad Account ID.
`CampaignId`	`String`	Campaigns.Id	Campaign ID of the ad group.
`FeedProfileId`	`String`		Feed Profile ID associated to the adgroup.
`AutoTargetingEnabled`	`Boolean`		Enable auto-targeting for ad group.
`BidInMicroCurrency`	`Integer`		Bid price in micro currency.
`BillableEvent`	`String`		Ad group billable event type.
`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`

AdGroupTargetingAnalytics¶

Get targeting analytics for one or more ad groups.

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdGroupTargetingAnalytics WHERE TargetingType = 'LOCATION'
SELECT * FROM AdGroupTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`AdGroupId`	`String`	AdGroups.Id	Id of the ad group.
`TargetingType`	`String`		Targeting type. The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION.
`TargetingValues`	`String`		Targeting type value.
`Date`	`Date`		Date the analytics row covers.
`SpendInDollar`	`Decimal`		Total spend in dollars.
`AdvertiserId`	`Double`		Id of the advertiser.
`AdGroupEntityStatus`	`Double`		Id of the advertiser.
`AdId`	`Double`		Id of the advertiser.
`CampaignId`	`String`	Campaigns.Id	Id of the Campaign.
`CampaignDailySpendCap`	`String`		Campaign daily spend cap.
`CampaignEntityStatus`	`String`		Campaign entity status.
`CampaignLifetimeSpendCap`	`Integer`		Campaign Lifetime Spend Cap.
`Ctr`	`Double`		Ctr.
`Ctr2`	`Double`		Ctr2.
`CheckoutRoas`	`Double`		Checkout roas.
`Clickthrough1`	`Integer`		Clickthrough1.
`Clickthrough2`	`Integer`		Clickthrough2.
`Clickthrough1Gross`	`Integer`		Clickthrough1 Gross.
`CpcInMicroDollar`	`Decimal`		Cpc In MicroDollar.
`CpmInMicroDollar`	`Decimal`		Cpm In MicroDollar.
`Ectr`	`Decimal`		Ectr.
`EcpeInDollar`	`Decimal`		Ecpe in Dollars.
`EngagementRate`	`Double`		The engagement rate.
`EengagementRate`	`Double`		E Engagement rate.
`EcpvInDollar`	`Decimal`		Ecpv in dollars.
`EcpcvInDollar`	`Decimal`		E Cpcv in Dollars.
`EcpcvP95InDollar`	`Decimal`		E Cpcv 95 percent in Dollars.
`EcpcInMicroDollar`	`Decimal`		Ecpc In MicroDollar.
`EcpmInMicroDollar`	`Decimal`		Ecpm In MicroDollar.
`Engagement1`	`Integer`		Engagement1.
`Engagement2`	`Integer`		Engagement2.
`Impression1`	`Integer`		Impression1.
`Impression1Gross`	`Integer`		Impression1 Gross.
`Impression2`	`Integer`		Impression2.
`IdeaPinProductTagVisit1`	`Integer`		Idea Pin Product Tag Visit1.
`IdeaPinProductTagVisit2`	`Integer`		Idea Pin Product Tag Visit2.
`InAppCheckoutCostPerAction`	`Double`		In App Checkout Cost Per Action.
`OutboundClick1`	`Integer`		Outboundclick1.
`OutboundClick2`	`Integer`		Outboundclick2.
`PinId`	`String`	Pins.Id	Id of the Pins.
`PageVisitCostPerAction`	`Double`		Page visit cost per action.
`PageVisitRoas`	`Double`		Page visit roas.
`PaidImpression`	`Integer`		PaidImpression.
`Repin1`	`Integer`		Repin1.
`Repin2`	`Integer`		Repin2.
`RepinRate`	`Double`		The repin rate.
`TotalClickthrough`	`Integer`		Total Clickthrough.
`TotalEngagementSignup`	`Integer`		Total Engagement Signup.
`TotalEngagementCheckout`	`Integer`		Total Engagement Checkout.
`TotalClickSignup`	`Integer`		Total Click Signup.
`TotalClickCheckout`	`Integer`		Total Click Checkout.
`TotalViewSignup`	`Integer`		Total View Signup.
`TotalViewCheckout`	`Integer`		Total View Checkout.
`TotalConversions`	`Integer`		Total Conversions.
`TotalEngagementSignupValueInMicroDollar`	`Decimal`		Total Engagement Signup Value In Micro Dollar.
`TotalEngagementCheckoutValueInMicroDollar`	`Decimal`		Total Engagement Checkout Value In Micro Dollar.
`TotalClickSignupValueInMicroDollar`	`Decimal`		Total Click Signup Value In Micro Dollar.
`TotalClickCheckoutValueInMicroDollar`	`Decimal`		Total Click Checkout Value In Micro Dollar.
`TotalViewSignupValueInMicroDollar`	`Decimal`		Total View Signup Value In Micro Dollar.
`TotalViewCheckoutValueInMicroDollar`	`Decimal`		Total View Checkout Value In Micro Dollar.
`TotalPageVisit`	`Integer`		Total Page Visit.
`TotalSignup`	`Integer`		Total Signup.
`TotalCheckout`	`Integer`		Total Checkout.
`TotalSignupValueInMicroDollar`	`Decimal`		Total Signup Value In Micro Dollar.
`TotalCheckoutValueInMicroDollar`	`Decimal`		Total Checkout Value In Micro Dollar.
`TotalVideo3secViews`	`Integer`		Total Video 3 second Views.
`TotalVideoP100Complete`	`Integer`		Total Video 100 percent Complete.
`TotalVideoP0Combined`	`Integer`		Total Video 0 percent Combined.
`TotalVideoP25Combined`	`Integer`		Total Video 25 percent Combined.
`TotalVideoP50Combined`	`Integer`		Total Video 50 percent Combined.
`TotalVideoP75Combined`	`Integer`		Total Video 75 percent Combined.
`TotalVideoP95Combined`	`Integer`		Total Video 95 percent Combined.
`TotalVideoMrcViews`	`Integer`		Total Video Mrc Views.
`TotalVideoAvgWatchtimeInSecond`	`Integer`		Total Video Avg Watchtime In Seconds.
`TotalRepinRate`	`Double`		Total Repin Rate.
`TotalWebCheckout`	`Integer`		Total Web Checkout.
`TotalWebCheckoutValueInMicroDollar`	`Decimal`		Total Web Checkout Value In Micro Dollar.
`TotalWebClickCheckout`	`Integer`		Total Web Click Checkout.
`TotalWebClickCheckoutValueInMicroDollar`	`Decimal`		Total Web Click Checkout Value In Micro Dollar.
`TotalWebEngagementCheckout`	`Integer`		Total Web Engagement Checkout.
`TotalWebEngagementCheckoutValueInMicroDollar`	`Decimal`		Total Web Engagement Checkout Value In Micro Dollar.
`TotalWebViewCheckout`	`Integer`		Total Web View Checkout.
`TotalWebViewCheckoutValueInMicroDollar`	`Decimal`		Total Web View Checkout Value In Micro Dollar.
`Video3secViews2`	`Integer`		Video 3 second Views.
`VideoLength`	`Integer`		VideoLength.
`VideoMrcViews2`	`Integer`		Video 2 second Views.
`VideoP0Combined2`	`Integer`		Video 0 percent Combined Views.
`VideoP100Complete2`	`Integer`		Video 100 percent Complete Views.
`VideoP25Combined2`	`Integer`		Video 25 percent Complete Views.
`VideoP50Combined2`	`Integer`		Video 50 percent Complete Views.
`VideoP75Combined2`	`Integer`		Video 75 percent Complete Views.
`VideoP95Combined2`	`Integer`		Video 95 percent Complete Views.
`WebCheckoutCostPerAction`	`Double`		Web checkout cost per action.
`WebCheckoutRoas`	`Double`		Web checkout roas.
`WebSessions1`	`Integer`		WebSessions1.
`WebSessions2`	`Integer`		WebSessions2.
`StartDate`	`Date`		Metric report start date.
`EndDate`	`Date`		Metric report end date.
`Granularity`	`String`		Granularity. The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns¶

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

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

Ads¶

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

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM Ads WHERE AdAccountId = '3457832451'

Columns¶

Name	Type	References	Description
`Id [KEY]`	`String`		The ID of this ad.
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`AdGroupId`	`String`	AdGroups.Id	ID of the ad group that contains the ad.
`AndroidDeepLink`	`String`		Deep link URL for Android devices. Not currently available. Using this field will generate an error.
`CampaignId`	`String`	Campaigns.Id	ID of the ad campaign that contains this ad.
`CarouselAndroidDeepLinks`	`String`		Comma-separated deep links for the carousel pin on Android.
`CarouselDestinationUrls`	`String`		Comma-separated destination URLs for the carousel pin to promote.
`CarouselIosDeepLinks`	`String`		Comma-separated deep links for the carousel pin on iOS.
`ClickTrackingUrl`	`String`		Tracking URL for the ad clicks.
`CollectionItemsDestinationUrlTemplate`	`String`		Destination URL template for all items within a collections drawer.
`CreatedTime`	`Datetime`		Pin creation time.
`CreativeType`	`String`		Ad creative type
`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.

AdsTargetingAnalytics¶

Get targeting analytics for one or more ads.

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM AdsTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`AdId`	`String`	Ads.Id	Id of the ad
`TargetingType`	`String`		Targeting type. The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, AUDIENCE_EXCLUDE, GEO, AGE_BUCKET, REGION.
`TargetingValues`	`String`		Targeting type value.
`Date`	`Date`		Date the analytics row covers.
`SpendInDollar`	`Decimal`		Total spend in dollars.
`AdvertiserId`	`Double`		Id of the advertiser.
`AdGroupEntityStatus`	`Double`		Id of the advertiser.
`MetricsAdId`	`String`	Ads.Id	Id of the ad
`CampaignId`	`String`	Campaigns.Id	Id of the Campaign.
`CampaignDailySpendCap`	`String`		Campaign daily spend cap.
`CampaignEntityStatus`	`String`		Campaign entity status.
`CampaignLifetimeSpendCap`	`Integer`		Campaign Lifetime Spend Cap.
`Ctr`	`Double`		Ctr.
`Ctr2`	`Double`		Ctr2.
`CheckoutRoas`	`Double`		Checkout roas.
`Clickthrough1`	`Integer`		Clickthrough1.
`Clickthrough2`	`Integer`		Clickthrough2.
`Clickthrough1Gross`	`Integer`		Clickthrough1 Gross.
`CpcInMicroDollar`	`Decimal`		Cpc In MicroDollar.
`CpmInMicroDollar`	`Decimal`		Cpm In MicroDollar.
`Ectr`	`Decimal`		Ectr.
`EcpeInDollar`	`Decimal`		Ecpe in Dollars.
`EngagementRate`	`Double`		The engagement rate.
`EengagementRate`	`Double`		E Engagement rate.
`EcpvInDollar`	`Decimal`		Ecpv in dollars.
`EcpcvInDollar`	`Decimal`		E Cpcv in Dollars.
`EcpcvP95InDollar`	`Decimal`		E Cpcv 95 percent in Dollars.
`EcpcInMicroDollar`	`Decimal`		Ecpc In MicroDollar.
`EcpmInMicroDollar`	`Decimal`		Ecpm In MicroDollar.
`Engagement1`	`Integer`		Engagement1.
`Engagement2`	`Integer`		Engagement2.
`Impression1`	`Integer`		Impression1.
`Impression1Gross`	`Integer`		Impression1 Gross.
`Impression2`	`Integer`		Impression2.
`IdeaPinProductTagVisit1`	`Integer`		Idea Pin Product Tag Visit1.
`IdeaPinProductTagVisit2`	`Integer`		Idea Pin Product Tag Visit2.
`InAppCheckoutCostPerAction`	`Double`		In App Checkout Cost Per Action.
`OutboundClick1`	`Integer`		Outboundclick1.
`OutboundClick2`	`Integer`		Outboundclick2.
`PinId`	`String`	Pins.Id	Id of the Pins.
`PageVisitCostPerAction`	`Double`		Page visit cost per action.
`PageVisitRoas`	`Double`		Page visit roas.
`PaidImpression`	`Integer`		PaidImpression.
`Repin1`	`Integer`		Repin1.
`Repin2`	`Integer`		Repin2.
`RepinRate`	`Double`		The repin rate.
`TotalClickthrough`	`Integer`		Total Clickthrough.
`TotalEngagementSignup`	`Integer`		Total Engagement Signup.
`TotalEngagementCheckout`	`Integer`		Total Engagement Checkout.
`TotalClickSignup`	`Integer`		Total Click Signup.
`TotalClickCheckout`	`Integer`		Total Click Checkout.
`TotalViewSignup`	`Integer`		Total View Signup.
`TotalViewCheckout`	`Integer`		Total View Checkout.
`TotalConversions`	`Integer`		Total Conversions.
`TotalEngagementSignupValueInMicroDollar`	`Decimal`		Total Engagement Signup Value In Micro Dollar.
`TotalEngagementCheckoutValueInMicroDollar`	`Decimal`		Total Engagement Checkout Value In Micro Dollar.
`TotalClickSignupValueInMicroDollar`	`Decimal`		Total Click Signup Value In Micro Dollar.
`TotalClickCheckoutValueInMicroDollar`	`Decimal`		Total Click Checkout Value In Micro Dollar.
`TotalViewSignupValueInMicroDollar`	`Decimal`		Total View Signup Value In Micro Dollar.
`TotalViewCheckoutValueInMicroDollar`	`Decimal`		Total View Checkout Value In Micro Dollar.
`TotalPageVisit`	`Integer`		Total Page Visit.
`TotalSignup`	`Integer`		Total Signup.
`TotalCheckout`	`Integer`		Total Checkout.
`TotalSignupValueInMicroDollar`	`Decimal`		Total Signup Value In Micro Dollar.
`TotalCheckoutValueInMicroDollar`	`Decimal`		Total Checkout Value In Micro Dollar.
`TotalVideo3secViews`	`Integer`		Total Video 3 second Views.
`TotalVideoP100Complete`	`Integer`		Total Video 100 percent Complete.
`TotalVideoP0Combined`	`Integer`		Total Video 0 percent Combined.
`TotalVideoP25Combined`	`Integer`		Total Video 25 percent Combined.
`TotalVideoP50Combined`	`Integer`		Total Video 50 percent Combined.
`TotalVideoP75Combined`	`Integer`		Total Video 75 percent Combined.
`TotalVideoP95Combined`	`Integer`		Total Video 95 percent Combined.
`TotalVideoMrcViews`	`Integer`		Total Video Mrc Views.
`TotalVideoAvgWatchtimeInSecond`	`Integer`		Total Video Avg Watchtime In Seconds.
`TotalRepinRate`	`Double`		Total Repin Rate.
`TotalWebCheckout`	`Integer`		Total Web Checkout.
`TotalWebCheckoutValueInMicroDollar`	`Decimal`		Total Web Checkout Value In Micro Dollar.
`TotalWebClickCheckout`	`Integer`		Total Web Click Checkout.
`TotalWebClickCheckoutValueInMicroDollar`	`Decimal`		Total Web Click Checkout Value In Micro Dollar.
`TotalWebEngagementCheckout`	`Integer`		Total Web Engagement Checkout.
`TotalWebEngagementCheckoutValueInMicroDollar`	`Decimal`		Total Web Engagement Checkout Value In Micro Dollar.
`TotalWebViewCheckout`	`Integer`		Total Web View Checkout.
`TotalWebViewCheckoutValueInMicroDollar`	`Decimal`		Total Web View Checkout Value In Micro Dollar.
`Video3secViews2`	`Integer`		Video 3 second Views.
`VideoLength`	`Integer`		VideoLength.
`VideoMrcViews2`	`Integer`		Video 2 second Views.
`VideoP0Combined2`	`Integer`		Video 0 percent Combined Views.
`VideoP100Complete2`	`Integer`		Video 100 percent Complete Views.
`VideoP25Combined2`	`Integer`		Video 25 percent Complete Views.
`VideoP50Combined2`	`Integer`		Video 50 percent Complete Views.
`VideoP75Combined2`	`Integer`		Video 75 percent Complete Views.
`VideoP95Combined2`	`Integer`		Video 95 percent Complete Views.
`WebCheckoutCostPerAction`	`Double`		Web checkout cost per action.
`WebCheckoutRoas`	`Double`		Web checkout roas.
`WebSessions1`	`Integer`		WebSessions1.
`WebSessions2`	`Integer`		WebSessions2.
`StartDate`	`Date`		Metric report start date.
`EndDate`	`Date`		Metric report end date.
`Granularity`	`String`		Granularity. The allowed values are TOTAL, DAY, HOUR, WEEK, MONTH.

Pseudo-Columns¶

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

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

Boards¶

Get a list of the boards owned by the User

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM Boards WHERE ID = '345787634451'

Columns¶

Name	Type	Description
`Id [KEY]`	`String`	Id of the Board
`Name`	`String`	Name of the Board
`Description`	`String`	Description of the Board
`OwnerUsername`	`String`	UserName of the Owner.
`Privacy`	`String`	Privacy setting for the board. The allowed values are PUBLIC, PROTECTED, SECRET.
`MediaImageCoverUrl`	`String`	Media image cover URL for the board.
`MediaPinThumbnailUrls`	`String`	Pin thumbnail URLs for the board.
`PinCount`	`Integer`	Pin count.
`FollowerCount`	`Integer`	Follower count.
`CollaboratorCount`	`Integer`	Collaborator count.
`CreatedAt`	`Datetime`	Created Time.
`BoardPinsModifiedAt`	`Datetime`	Modified Time.

BoardSections¶

Get a list of the boards owned by the User

Table Specific Information¶

Select¶

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

BoardId supports the = operator.

For example:

SELECT * FROM BoardSections WHERE BoardId = '345787634451'

Columns¶

Name	Type	References	Description
`Id [KEY]`	`String`		Id of the Section.
`Name`	`String`		Name of the Section.
`BoardId`	`String`	Boards.Id	Id of the Board.

Campaigns¶

Get account information for the operation user_account

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM Campaigns WHERE AdAccountId = '3457832451'

Columns¶

Name	Type	References	Description
`Id [KEY]`	`String`		Campaign ID.
`AdAccountId`	`String`	AdAccounts.Id	Campaign's Advertiser ID.
`CreatedTime`	`Datetime`		Campaign creation time.
`DailySpendCap`	`Integer`		Campaign total spending cap.
`LifetimeSpendCap`	`Integer`		Campaign daily spending cap.
`Name`	`String`		Campaign name.
`ObjectiveType`	`String`		Campaign objective type.
`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.

CampaignTargetingAnalytics¶

Get targeting analytics for one or more campaign.

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM CampaignTargetingAnalytics WHERE CampaignId = '451'
SELECT * FROM CampaignTargetingAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`TargetingType`	`String`		Targeting type. The allowed values are KEYWORD, APPTYPE, GENDER, LOCATION, PLACEMENT, COUNTRY, TARGETED_INTEREST, PINNER_INTEREST, AUDIENCE_INCLUDE, 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`
`ClickWindowDays`	`Integer`
`EngagementWindowDays`	`Integer`
`ViewWindowDays`	`Integer`
`ConversionReportTime`	`Integer`

Pins¶

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

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM Pins WHERE Id = '3457832451'
SELECT * FROM Pins WHERE BoardId = '3457832451'

Columns¶

Name	Type	References	Description
`Id [KEY]`	`String`		Id of the Pin
`BoardId`	`String`	Boards.Id	Id of the Board
`SectionId`	`String`	BoardSections.Id	Id of the Section
`AltText`	`String`		AltText
`BoardOwnerUsername`	`String`		UserName of the BoardOwner.
`CreatedAt`	`Datetime`		Created At Date Time
`Description`	`String`		Description of the Pin.
`Link`	`String`		Link to the Pin.
`MediaType`	`String`		MediaType of the Pin.
`Media`	`String`		Media for the Pin.
`Title`	`String`		Title of the Pin.
`PinMetrics`	`String`		Pin metrics of the Pin.

ProductGroupAnalytics¶

Get targeting analytics for one or more campaign.

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM ProductGroupAnalytics WHERE AdAccountId = '3457832451'
SELECT * FROM ProductGroupAnalytics WHERE ProductGroupId = '451'
SELECT * FROM ProductGroupAnalytics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	References	Description
`AdAccountId`	`String`	AdAccounts.Id	Unique identifier of an ad account.
`ProductGroupId`	`String`		Product group Ids .
`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`
`ClickWindowDays`	`Integer`
`EngagementWindowDays`	`Integer`
`ViewWindowDays`	`Integer`
`ConversionReportTime`	`Integer`

TargetingTypeAgeBucket¶

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

Columns¶

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

TargetingTypeAppType¶

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

Columns¶

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

TargetingTypeGender¶

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

Columns¶

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

TargetingTypeGeo¶

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

Columns¶

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

TargetingTypeInterests¶

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

Columns¶

Name	Type	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.

TargetingtypeLocale¶

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

Columns¶

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

TargetingTypeLocations¶

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

Table Specific Information¶

Select¶

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

For example, the following queries are processed server side:

SELECT * FROM TargetingTypeLocations

Columns¶

Name	Type	References	Description
`LocationKey`	`String`		It contains the key of the Location
`LocationValue`	`String`		It contains the value of the Location

UserAccount¶

Get account information for the operation User Account

Table Specific Information¶

Select¶

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

Columns¶

Name	Type	Description
`AccountType`	`String`	Type of account.
`ProfileImage`	`String`	Profile Image.
`Username`	`String`	Username.
`WebsiteURL`	`String`	Website URL.
`BoardCount`	`Integer`	Board count.
`PinCount`	`Integer`	Pin count.
`FollowerCount`	`Integer`	Follower count.
`FollowingCount`	`Integer`	Following count.

Pseudo-Columns¶

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

Name	Type	Description
`AdAccountID`	`String`

UserAccountDailyMetrics¶

Get Daily Metric of User Account

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM UserAccountDailyMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountDailyMetrics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	Description
`OutboundClick`	`Integer`	Total outbound click.
`OutboundClickRate`	`Decimal`	Outbound Click Rate.
`Engagement`	`Integer`	Total engagements.
`EngagementRate`	`Decimal`	Engagement Rate.
`PinClick`	`Integer`	Total pin clicks.
`PinClickRate`	`Decimal`	Pin Click Rate.
`Impression`	`Integer`	Total impressions.
`Save`	`Integer`	Total saves.
`SaveRate`	`Decimal`	Save Rate.
`DataStatus`	`String`	Metrics Availablity.
`Date`	`Date`	Metrics Date.
`StartDate`	`Date`	Metric report start date.
`EndDate`	`Date`	Metric report end date.

Pseudo-Columns¶

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

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

UserAccountSummaryMetrics¶

Get Summary Metric of User Account

Table Specific Information¶

Select¶

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

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

For example:

SELECT * FROM UserAccountSummaryMetrics WHERE AppTypes = 'MOBILE'
SELECT * FROM UserAccountSummaryMetrics WHERE AdAccountId = '3457832451' and StartDate >= '2024-01-06' and EndDate <= '2024-04-05'

Columns¶

Name	Type	Description
`OutboundClick`	`Integer`	Total outbound click.
`OutboundClickRate`	`Decimal`	Outbound Click Rate.
`Engagement`	`Integer`	Total engagements.
`EngagementRate`	`Decimal`	Engagement Rate.
`PinClick`	`Integer`	Total pin clicks.
`PinClickRate`	`Decimal`	Pin Click Rate.
`Impression`	`Integer`	Total impressions.
`Save`	`Integer`	Total saves.
`SaveRate`	`Decimal`	Save Rate.
`StartDate`	`Date`	Metric report start date.
`EndDate`	`Date`	Metric report end date.

Pseudo-Columns¶

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

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

UserAccountTopVideoPinAnalytics¶

Get analytics data about a user's top pins.

Table Specific Information¶

Select¶

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

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

For example:

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

Columns¶

Name	Type	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`
`NumOfPins`	`Integer`
`MetricTypes`	`String`
`AppType`	`String`
`PiFormat`	`String`
`FromClaimedContent`	`String`

UserTopPinAnalytics¶

Get analytics data about a user's top pins.

Table Specific Information¶

Select¶

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

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

For example:

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

Columns¶

Name	Type	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`
`NumOfPins`	`Integer`
`MetricTypes`	`String`
`AppType`	`String`
`PiFormat`	`String`
`FromClaimedContent`	`String`

Stored Procedures¶

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT operations with Pinterest.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Pinterest, along with an indication of whether the procedure succeeded or failed.

Pinterest Connector Stored Procedures¶

Name	Description
`GetOAuthAccessToken`	Gets an authentication token from Pinterest.
`GetOAuthAuthorizationURL`	Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.
`RefreshOAuthAccessToken`	Refreshes the OAuth access token from Pinterest.

GetOAuthAccessToken¶

Gets an authentication token from Pinterest.

Input¶

Name	Type	Required	Description
`AuthMode`	`String`	False	The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP.
`Scope`	`String`	False	A comma-separated list of permissions to request from the user. Please check the Pinterest API for a list of available permissions. The default value is ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read.
`CallbackUrl`	`String`	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Pinterest app settings. Only needed when the Authmode parameter is Web.
`Verifier`	`String`	False	The verifier returned from Pinterest after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
`State`	`String`	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pinterest authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns¶

Name	Type	Description
`OAuthAccessToken`	`String`	The access token used for communication with Pinterest.
`OAuthRefreshToken`	`String`	The OAuth refresh token. This is the same as the access token in the case of Pinterest.
`ExpiresIn`	`String`	The remaining lifetime on the access token. A -1 denotes that it will not expire.

GetOAuthAuthorizationURL¶

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input¶

Name	Type	Required	Description
`CallbackUrl`	`String`	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Pinterest app settings.
`Scope`	`String`	False	A comma-separated list of scopes to request from the user. Please check the Pinterest API documentation for a list of available permissions. The default value is ads:read,boards:read,boards:read_secret,pins:read,pins:read_secret,user_accounts:read.
`State`	`String`	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Pinterest authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns¶

Name	Type	Description
`URL`	`String`	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

RefreshOAuthAccessToken¶

Refreshes the OAuth access token from Pinterest.

Input¶

Name	Type	Required	Description
`OAuthRefreshToken`	`String`	True	Set this to the token value that expired

Result Set Columns¶

Name	Type	Description
`OAuthAccessToken`	`String`	The access token used for communication with Pinterest.
`OAuthRefreshToken`	`String`	The OAuth refresh token. This is the same as the access token in the case of Pinterest.
`ExpiresIn`	`String`	The remaining lifetime on the access token. A -1 denotes that it will not expire.

System Tables¶

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

Schema Tables¶

The following tables return database metadata for Pinterest:

sys_catalogs: Lists the available databases.
sys_schemas: Lists the available schemas.
sys_tables: Lists the available tables and views.
sys_tablecolumns: Describes the columns of the available tables and views.
sys_procedures: Describes the available stored procedures.
sys_procedureparameters: Describes stored procedure parameters.
sys_keycolumns: Describes the primary and foreign keys.
sys_indexes: Describes the available indexes.

Data Source Tables¶

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

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

Query Information Tables¶

The following table returns query statistics for data modification queries:

sys_identity: Returns information about batch operations or single updates.

sys_catalogs¶

Lists the available databases.

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

SELECT * FROM sys_catalogs

Columns¶

Name	Type	Description
`CatalogName`	`String`	The database name.

sys_schemas¶

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns¶

Name	Type	Description
`CatalogName`	`String`	The database name.
`SchemaName`	`String`	The schema name.

sys_tables¶

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns¶

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

sys_tablecolumns¶

Describes the columns of the available tables and views.

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

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='AdAccounts'

Columns¶

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

sys_procedures¶

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures

Columns¶

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

sys_procedureparameters¶

Describes stored procedure parameters.

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

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

Columns¶

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the stored procedure.
`SchemaName`	`String`	The name of the schema containing the stored procedure.
`ProcedureName`	`String`	The name of the stored procedure containing the parameter.
`ColumnName`	`String`	The name of the stored procedure parameter.
`Direction`	`Int32`	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
`DataTypeName`	`String`	The name of the data type.
`DataType`	`Int32`	An integer indicating the data type. This value is determined at run time based on the environment.
`Length`	`Int32`	The number of characters allowed for character data. The number of digits allowed for numeric data.
`NumericPrecision`	`Int32`	The maximum precision for numeric data. The column length in characters for character and date-time data.
`NumericScale`	`Int32`	The number of digits to the right of the decimal point in numeric data.
`IsNullable`	`Boolean`	Whether the parameter can contain null.
`IsRequired`	`Boolean`	Whether the parameter is required for execution of the procedure.
`IsArray`	`Boolean`	Whether the parameter is an array.
`Description`	`String`	The description of the parameter.
`Ordinal`	`Int32`	The index of the parameter.

sys_keycolumns¶

Describes the primary and foreign keys.

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

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='AdAccounts'

Columns¶

Name	Type	Description
`CatalogName`	`String`	The name of the database containing the key.
`SchemaName`	`String`	The name of the schema containing the key.
`TableName`	`String`	The name of the table containing the key.
`ColumnName`	`String`	The name of the key column.
`IsKey`	`Boolean`	Whether the column is a primary key in the table referenced in the TableName field.
`IsForeignKey`	`Boolean`	Whether the column is a foreign key referenced in the TableName field.
`PrimaryKeyName`	`String`	The name of the primary key.
`ForeignKeyName`	`String`	The name of the foreign key.
`ReferencedCatalogName`	`String`	The database containing the primary key.
`ReferencedSchemaName`	`String`	The schema containing the primary key.
`ReferencedTableName`	`String`	The table containing the primary key.
`ReferencedColumnName`	`String`	The column name of the primary key.

sys_foreignkeys¶

Describes the foreign keys.

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

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns¶

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

sys_primarykeys¶

Describes the primary keys.

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

SELECT * FROM sys_primarykeys

Columns¶

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

sys_indexes¶

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

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

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns¶

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

sys_connection_props¶

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

When querying this table, the config connection string should be used:

jdbc:cdata:pinterest:config:

This connection string enables you to query this table without a valid connection.

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns¶

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

sys_sqlinfo¶

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

Discovering the Data Source's SELECT Capabilities¶

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

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

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

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

Columns¶

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

sys_identity¶

Returns information about attempted modifications.

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

SELECT * FROM sys_identity

Columns¶

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

sys_information¶

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns¶

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

Advanced Configurations Properties¶

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

Connection

Property	Description
`AdAccountId`	Unique identifier of an Ad Account.

OAuth

Property	Description
`InitiateOAuth`	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
`OAuthClientId`	The client ID assigned when you register your application with an OAuth authorization server.
`OAuthClientSecret`	The client secret assigned when you register your application with an OAuth authorization server.
`OAuthAccessToken`	The access token for connecting using OAuth.
`OAuthSettingsLocation`	The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with `'memory://'`.
`CallbackURL`	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
`OAuthVerifier`	The verifier code returned from the OAuth authorization URL.
`OAuthRefreshToken`	The OAuth refresh token for the corresponding OAuth access token.
`OAuthExpiresIn`	The lifetime in seconds of the OAuth AccessToken.
`OAuthTokenTimestamp`	The Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL

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

Schema

Property	Description
`Location`	A path to the directory that contains the schema files defining tables, views, and stored procedures.
`BrowsableSchemas`	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property	Description
`MaxRows`	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
`Other`	These hidden properties are used only in specific use cases.
`PseudoColumns`	This property indicates whether or not to include pseudo columns as columns to the table.
`Timeout`	The value in seconds until the timeout error is thrown, canceling the operation.
`UserDefinedViews`	A filepath pointing to the JSON configuration file containing your custom views.

Connection¶

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

Property	Description
`AdAccountId`	Unique identifier of an Ad Account.

AdAccountId¶

Unique identifier of an Ad Account.

Data Type¶

string

Default Value¶

""

Remarks¶

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

OAuth¶

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

Property	Description
`InitiateOAuth`	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
`OAuthClientId`	The client ID assigned when you register your application with an OAuth authorization server.
`OAuthClientSecret`	The client secret assigned when you register your application with an OAuth authorization server.
`OAuthAccessToken`	The access token for connecting using OAuth.
`OAuthSettingsLocation`	The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with `'memory://'`.
`CallbackURL`	The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
`OAuthVerifier`	The verifier code returned from the OAuth authorization URL.
`OAuthRefreshToken`	The OAuth refresh token for the corresponding OAuth access token.
`OAuthExpiresIn`	The lifetime in seconds of the OAuth AccessToken.
`OAuthTokenTimestamp`	The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth¶

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values¶

OFF, GETANDREFRESH, REFRESH

Data Type¶

string

Default Value¶

OFF

Remarks¶

The following options are available:

OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId¶

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

Data Type¶

string

Default Value¶

""

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.

OAuthClientSecret¶

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

Data Type¶

string

Default Value¶

""

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.

OAuthAccessToken¶

The access token for connecting using OAuth.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation¶

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH . Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'.

Data Type¶

string

Default Value¶

%APPDATA%\Pinterest Data Provider\OAuthSettings.txt

Remarks¶

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.

Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.

The default location is "%APPDATA%\Pinterest Data Provider\OAuthSettings.txt" with %APPDATA% set to the user's configuration directory. The default values are

Windows: "register://%DSN"
Unix: "%AppData%..."
Mac: "%AppData%..."

where DSN is the name of the current DSN used in the open connection.

The following table lists the value of %APPDATA% by OS:

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

CallbackURL¶

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type¶

string

Default Value¶

https://localhost:33333/

Remarks¶

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier¶

The verifier code returned from the OAuth authorization URL.

Data Type¶

string

Default Value¶

""

Remarks¶

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines¶

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified location. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken¶

The OAuth refresh token for the corresponding OAuth access token.

Data Type¶

string

Default Value¶

""

Remarks¶

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn¶

The lifetime in seconds of the OAuth AccessToken.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp¶

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type¶

string

Default Value¶

""

Remarks¶

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL¶

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

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

SSLServerCert¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
A path to a local file containing the certificate	`C:\\cert.cer`
The public key (example shortened for brevity)	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
The MD5 Thumbprint (hex values can also be either space or colon separated)	`ecadbdda5a1529c58a1e9e09828d70e4`
The SHA1 Thumbprint (hex values can also be either space or colon separated)	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

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

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

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

Schema¶

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

Property	Description
`Location`	A path to the directory that contains the schema files defining tables, views, and stored procedures.
`BrowsableSchemas`	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
`Tables`	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
`Views`	Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location¶

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

Data Type¶

string

Default Value¶

%APPDATA%\Pinterest Data Provider\Schema

Remarks¶

The path to a directory which contains the schema files for the connector (.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%\Pinterest Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

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

BrowsableSchemas¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

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

Tables¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

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

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.

Views¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

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

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.

Miscellaneous¶

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

Property	Description
`MaxRows`	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
`Other`	These hidden properties are used only in specific use cases.
`PseudoColumns`	This property indicates whether or not to include pseudo columns as columns to the table.
`Timeout`	The value in seconds until the timeout error is thrown, canceling the operation.
`UserDefinedViews`	A filepath pointing to the JSON configuration file containing your custom views.

MaxRows¶

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

Data Type¶

int

Default Value¶

-1

Remarks¶

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

Other¶

These hidden properties are used only in specific use cases.

Data Type¶

string

Default Value¶

""

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¶

Property	Description
`DefaultColumnSize`	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
`ConvertDateTimeToGMT`	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
`RecordToFile=filename`	Records the underlying socket data transfer to the specified file.

PseudoColumns¶

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

Data Type¶

string

Default Value¶

""

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, "*=*".

Timeout¶

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

Data Type¶

int

Default Value¶

60

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 connector throws an exception.

UserDefinedViews¶

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

Data Type¶

string

Default Value¶

""

Remarks¶

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector 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 connector.

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.