Pinterest Connector Objects

note: This feature is a Beta Service. A customer may opt to try a Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms. If you have questions or feedback about this Beta Service, contact the Data 360 Connector team at datacloud-connectors-beta@salesforce.com.

Objects Supported

Name	Description
AdAccountAnalytics	Get analytics for the specified AdAccountId
AdAccountAnalyticsReport	Get the ad account analytics report
AdAccounts	Get a list of the ad_accounts that the User has access to.
AdAccountTargetingAnalytics	Get targeting analytics for an ad account.
AdAnalytics	Get analytics for the ads in the specified AdAccountId
AdCampaignAnalytics	Get analytics for the specified campaigns in the specified AdAccountId
AdGroupAnalytics	Get analytics for the ad groups in the specified AdAccountId
AdGroups	Get a list of the ad_accounts that the User has access to.
AdGroupTargetingAnalytics	Get targeting analytics for one or more ad groups.
Ads	Get a list of the ad_accounts that the User has access to.
AdsTargetingAnalytics	Get targeting analytics for one or more ads.
AudienceInsights	Get Audience Insights for an ad account.
AudienceInsightsScopeAndType	Get the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction on pins.
Audiences	Get list of audiences for the ad account.
Boards	Get a list of the boards owned by the User
BoardSections	Get a list of the boards owned by the User
Campaigns	Get account information for the operation user_account
CampaignTargetingAnalytics	Get targeting analytics for one or more campaign.
CatalogHotelReport	Get the hotel catalog report
CatalogProcessingResultItemIssues	Fetch feeds owned by the operation user_account
CatalogRetailReport	Get the retail catalog report
Catalogs	Fetch catalogs owned by the operation user_account
CatalogTypeCreativeAssetsItems	Get the items of the catalog of type CREATIVE_ASSETS owned by the operation user_account
CatalogTypeHotelItems	Get the items of the catalog of type HOTEL owned by the operation user_account
CatalogTypeRetailItems	Get the items of the catalog of type RETAIL owned by the operation user_account
CustomerLists	Get a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience.
FeedProcessingResults	Fetch feeds owned by the operation user_account
Feeds	Fetch feeds owned by the operation user_account
Followers	Get a list of your followers.
Following	Get a list of your followers.
FollowingBoards	Get a list of the boards a user follows.
FollowingInterests	Get a list of a user's following interests in one place.
LinkedBusinesses	Get a list of your linked business accounts.
Pins	Get a Pin owned by the owned by the User or on a group board that has been shared with this account
ProductGroupAnalytics	Get targeting analytics for one or more campaign.
TargetingTypeAgeBucket	Get a list of the age bucket which are available inside the targets.
TargetingTypeAppType	Get a list of the app type which are available inside the targets.
TargetingTypeAudienceExclude	Get a list of the interest which are available inside the targets.
TargetingTypeAudienceInclude	Get a list of the interest which are available inside the targets.
TargetingTypeGender	Get a list of the gender which are available inside the targets.
TargetingTypeGeo	Get a list of the geo which are available inside the targets.
TargetingTypeInterests	Get a list of the interest which are available inside the targets.
TargetingTypeKeyword	Get a list of the interest which are available inside the targets.
TargetingtypeLocale	Get a list of the locale which are available inside the targets.
TargetingTypeLocations	Get a list of the location which are available inside the targets.
UserAccount	Get account information for the operation User Account
UserAccountDailyMetrics	Get Daily Metric of User Account
UserAccountSummaryMetrics	Get Summary Metric of User Account
UserAccountTopVideoPinAnalytics	Get analytics data about a user's top pins.
UserTopPinAnalytics	Get analytics data about a user's top pins.
UserVerificationCodeForWebsiteClaim	Get verification code for user to install on the website to claim it.
UserWebsites	Get user websites, claimed or not.

AdAccountAnalytics

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

Return to Top

AdAccountAnalyticsReport

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Id of the ad account.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity
Level	String	True		No	Level of the report.
AdGroupEntityStatus	String	True		No
AdGroupId	String	True		No
AdGroupName	String	True		No
AdGroupStatus	String	True		No
AdId	String	True		No
AdName	String	True		No
AdStatus	String	True		No
AdvertiserId	String	True		No
APPINSTALLCOSTPERACTION	Integer	True		No
CAMPAIGNDAILYSPENDCAP	Integer	True		No
CAMPAIGNENTITYSTATUS	String	True		No
CAMPAIGNID	String	True		No
CAMPAIGNLIFETIMESPENDCAP	Integer	True		No
CAMPAIGNMANAGEDSTATUS	String	True		No
CAMPAIGNNAME	String	True		No
CAMPAIGNSTATUS	String	True		No
CHECKOUTROAS	String	True		No
CLICKTHROUGH1	Integer	True		No
CLICKTHROUGH1GROSS	Integer	True		No
CLICKTHROUGH2	Integer	True		No
CPCINMICRODOLLAR	Integer	True		No
CPCVINMICRODOLLAR	Integer	True		No
CPCVP95INMICRODOLLAR	Integer	True		No
CPMINDOLLAR	Integer	True		No
CPMINMICRODOLLAR	Integer	True		No
CPVINMICRODOLLAR	Integer	True		No
CTR	Integer	True		No
CTR2	Integer	True		No
ECPCINDOLLAR	Integer	True		No
ECPCINMICRODOLLAR	Integer	True		No
ECPCVINDOLLAR	Integer	True		No
ECPCVP95INDOLLAR	Integer	True		No
ECPEINDOLLAR	Integer	True		No
ECPMINMICRODOLLAR	Integer	True		No
ECPVINDOLLAR	Integer	True		No
ECTR	Integer	True		No
EENGAGEMENTRATE	Integer	True		No
ENGAGEMENT1	Integer	True		No
ENGAGEMENT2	Integer	True		No
ENGAGEMENTRATE	Integer	True		No
IDEAPINPRODUCTTAGVISIT1	String	True		No
IDEAPINPRODUCTTAGVISIT2	String	True		No
IMPRESSION1	Integer	True		No
IMPRESSION1GROSS	Integer	True		No
IMPRESSION2	Integer	True		No
INAPPADDTOCARTCOSTPERACTION	Integer	True		No
INAPPADDTOCARTROAS	String	True		No
INAPPAPPINSTALLCOSTPERACTION	Integer	True		No
INAPPAPPINSTALLROAS	String	True		No
INAPPCHECKOUTCOSTPERACTION	Integer	True		No
INAPPCHECKOUTROAS	String	True		No
INAPPSEARCHCOSTPERACTION	Integer	True		No
INAPPSEARCHROAS	String	True		No
INAPPSIGNUPCOSTPERACTION	Integer	True		No
INAPPSIGNUPROAS	String	True		No
INAPPUNKNOWNCOSTPERACTION	Integer	True		No
INAPPUNKNOWNROAS	String	True		No
OFFLINECHECKOUTCOSTPERACTION	Integer	True		No
OFFLINECHECKOUTROAS	String	True		No
OFFLINECUSTOMCOSTPERACTION	Integer	True		No
OFFLINECUSTOMROAS	String	True		No
OFFLINELEADCOSTPERACTION	Integer	True		No
OFFLINELEADROAS	String	True		No
OFFLINESIGNUPCOSTPERACTION	Integer	True		No
OFFLINESIGNUPROAS	String	True		No
OFFLINEUNKNOWNCOSTPERACTION	Integer	True		No
OFFLINEUNKNOWNROAS	String	True		No
ONSITECHECKOUTS1	Integer	True		No
OUTBOUNDCLICK1	Integer	True		No
OUTBOUNDCLICK2	Integer	True		No
PAGEVISITCOSTPERACTION	Integer	True		No
PAGEVISITROAS	String	True		No
PAIDIMPRESSION	Integer	True		No
PINID	String	True		No
PINPROMOTIONID	String	True		No
PINPROMOTIONNAME	String	True		No
PINPROMOTIONSTATUS	String	True		No
PRODUCTGROUPID	String	True		No
REPIN1	Integer	True		No
REPIN2	Integer	True		No
REPINRATE	String	True		No
SPENDINDOLLAR	Integer	True		No
SPENDINMICRODOLLAR	Integer	True		No
TOTALADDTOCARTDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALADDTOCARTDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALADDTOCARTDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALADDTOCARTMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALADDTOCARTMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALADDTOCARTMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALADDTOCARTTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALADDTOCARTTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALADDTOCARTTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALAPPINSTALL	Integer	True		No
TOTALAPPINSTALLDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALAPPINSTALLDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALAPPINSTALLDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALAPPINSTALLMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALAPPINSTALLMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALAPPINSTALLMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALAPPINSTALLTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALAPPINSTALLTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALAPPINSTALLTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALCHECKOUT	Integer	True		No
TOTALCHECKOUTDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCHECKOUTDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCHECKOUTDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALCHECKOUTMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCHECKOUTMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCHECKOUTMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALCHECKOUTQUANTITY	Integer	True		No
TOTALCHECKOUTTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCHECKOUTTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCHECKOUTTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKADDTOCART	Integer	True		No
TOTALCLICKADDTOCARTQUANTITY	Integer	True		No
TOTALCLICKADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKAPPINSTALL	Integer	True		No
TOTALCLICKAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKCHECKOUT	Integer	True		No
TOTALCLICKCHECKOUTQUANTITY	Integer	True		No
TOTALCLICKCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKCUSTOM	Integer	True		No
TOTALCLICKCUSTOMQUANTITY	Integer	True		No
TOTALCLICKCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKLEAD	Integer	True		No
TOTALCLICKLEADQUANTITY	Integer	True		No
TOTALCLICKLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKPAGEVISIT	Integer	True		No
TOTALCLICKPAGEVISITQUANTITY	Integer	True		No
TOTALCLICKPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKSEARCH	Integer	True		No
TOTALCLICKSEARCHQUANTITY	Integer	True		No
TOTALCLICKSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKSIGNUP	Integer	True		No
TOTALCLICKSIGNUPQUANTITY	Integer	True		No
TOTALCLICKSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKUNKNOWN	Integer	True		No
TOTALCLICKUNKNOWNQUANTITY	Integer	True		No
TOTALCLICKUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKVIEWCATEGORY	String	True		No
TOTALCLICKVIEWCATEGORYQUANTITY	Integer	True		No
TOTALCLICKVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKWATCHVIDEO	Integer	True		No
TOTALCLICKWATCHVIDEOQUANTITY	Integer	True		No
TOTALCLICKWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALCLICKTHROUGH	Integer	True		No
TOTALCONVERSIONS	Integer	True		No
TOTALCONVERSIONSQUANTITY	Integer	True		No
TOTALCONVERSIONSVALUEINMICRODOLLAR	Integer	True		No
TOTALCUSTOM	Integer	True		No
TOTALCUSTOMDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCUSTOMDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCUSTOMDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALCUSTOMMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCUSTOMMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCUSTOMMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALCUSTOMTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALCUSTOMTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALCUSTOMTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALENGAGEMENT	Integer	True		No
TOTALENGAGEMENTADDTOCART	Integer	True		No
TOTALENGAGEMENTADDTOCARTQUANTITY	Integer	True		No
TOTALENGAGEMENTADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTAPPINSTALL	Integer	True		No
TOTALENGAGEMENTAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTCHECKOUT	Integer	True		No
TOTALENGAGEMENTCHECKOUTQUANTITY	Integer	True		No
TOTALENGAGEMENTCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTCUSTOM	Integer	True		No
TOTALENGAGEMENTCUSTOMQUANTITY	Integer	True		No
TOTALENGAGEMENTCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTLEAD	Integer	True		No
TOTALENGAGEMENTLEADQUANTITY	Integer	True		No
TOTALENGAGEMENTLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTPAGEVISIT	Integer	True		No
TOTALENGAGEMENTPAGEVISITQUANTITY	Integer	True		No
TOTALENGAGEMENTPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTSEARCH	Integer	True		No
TOTALENGAGEMENTSEARCHQUANTITY	Integer	True		No
TOTALENGAGEMENTSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTSIGNUP	Integer	True		No
TOTALENGAGEMENTSIGNUPQUANTITY	Integer	True		No
TOTALENGAGEMENTSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTUNKNOWN	Integer	True		No
TOTALENGAGEMENTUNKNOWNQUANTITY	Integer	True		No
TOTALENGAGEMENTUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTVIEWCATEGORY	String	True		No
TOTALENGAGEMENTVIEWCATEGORYQUANTITY	Integer	True		No
TOTALENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALENGAGEMENTWATCHVIDEO	Integer	True		No
TOTALENGAGEMENTWATCHVIDEOQUANTITY	Integer	True		No
TOTALENGAGEMENTWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALIDEAPINPRODUCTTAGVISIT	Integer	True		No
TOTALIMPRESSIONFREQUENCY	Integer	True		No
TOTALIMPRESSIONUSER	Integer	True		No
TOTALINAPPADDTOCART	String	True		No
TOTALINAPPADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPAPPINSTALL	Integer	True		No
TOTALINAPPAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCHECKOUT	Integer	True		No
TOTALINAPPCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKADDTOCART	Integer	True		No
TOTALINAPPCLICKADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKAPPINSTALL	Integer	True		No
TOTALINAPPCLICKAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKCHECKOUT	Integer	True		No
TOTALINAPPCLICKCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKSEARCH	Integer	True		No
TOTALINAPPCLICKSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKSIGNUP	Integer	True		No
TOTALINAPPCLICKSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPCLICKUNKNOWN	Integer	True		No
TOTALINAPPCLICKUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTADDTOCART	Integer	True		No
TOTALINAPPENGAGEMENTADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTAPPINSTALL	Integer	True		No
TOTALINAPPENGAGEMENTAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTCHECKOUT	Integer	True		No
TOTALINAPPENGAGEMENTCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTSEARCH	Integer	True		No
TOTALINAPPENGAGEMENTSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTSIGNUP	Integer	True		No
TOTALINAPPENGAGEMENTSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPENGAGEMENTUNKNOWN	Integer	True		No
TOTALINAPPENGAGEMENTUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPSEARCH	Integer	True		No
TOTALINAPPSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPSIGNUP	Integer	True		No
TOTALINAPPSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPUNKNOWN	Integer	True		No
TOTALINAPPUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWADDTOCART	Integer	True		No
TOTALINAPPVIEWADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWAPPINSTALL	Integer	True		No
TOTALINAPPVIEWAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWCHECKOUT	Integer	True		No
TOTALINAPPVIEWCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWSEARCH	Integer	True		No
TOTALINAPPVIEWSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWSIGNUP	Integer	True		No
TOTALINAPPVIEWSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALINAPPVIEWUNKNOWN	String	True		No
TOTALINAPPVIEWUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALLEAD	Integer	True		No
TOTALLEADDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALLEADDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALLEADDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALLEADMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALLEADMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALLEADMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALLEADTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALLEADTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALLEADTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALOFFLINECHECKOUT	Integer	True		No
TOTALOFFLINECHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECLICKCHECKOUT	Integer	True		No
TOTALOFFLINECLICKCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECLICKCUSTOM	Integer	True		No
TOTALOFFLINECLICKCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECLICKLEAD	Integer	True		No
TOTALOFFLINECLICKLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECLICKSIGNUP	Integer	True		No
TOTALOFFLINECLICKSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECLICKUNKNOWN	Integer	True		No
TOTALOFFLINECLICKUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINECUSTOM	Integer	True		No
TOTALOFFLINECUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEENGAGEMENTCHECKOUT	Integer	True		No
TOTALOFFLINEENGAGEMENTCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEENGAGEMENTCUSTOM	Integer	True		No
TOTALOFFLINEENGAGEMENTCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEENGAGEMENTLEAD	Integer	True		No
TOTALOFFLINEENGAGEMENTLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEENGAGEMENTSIGNUP	Integer	True		No
TOTALOFFLINEENGAGEMENTSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEENGAGEMENTUNKNOWN	Integer	True		No
TOTALOFFLINEENGAGEMENTUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINELEAD	Integer	True		No
TOTALOFFLINELEADVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINESIGNUP	Integer	True		No
TOTALOFFLINESIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEUNKNOWN	Integer	True		No
TOTALOFFLINEUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEVIEWCHECKOUT	Integer	True		No
TOTALOFFLINEVIEWCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEVIEWCUSTOM	Integer	True		No
TOTALOFFLINEVIEWCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEVIEWLEAD	Integer	True		No
TOTALOFFLINEVIEWLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEVIEWSIGNUP	Integer	True		No
TOTALOFFLINEVIEWSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALOFFLINEVIEWUNKNOWN	Integer	True		No
TOTALOFFLINEVIEWUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALPAGEVISIT	Integer	True		No
TOTALPAGEVISITDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALPAGEVISITDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALPAGEVISITDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALPAGEVISITMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALPAGEVISITMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALPAGEVISITMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALPAGEVISITTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALPAGEVISITTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALPAGEVISITTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALREPINRATE	Integer	True		No
TOTALSEARCHDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSEARCHDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSEARCHDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSEARCHMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSEARCHMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSEARCHMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSEARCHTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSEARCHTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSEARCHTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSIGNUP	Integer	True		No
TOTALSIGNUPDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSIGNUPDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSIGNUPDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSIGNUPMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSIGNUPMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSIGNUPMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSIGNUPTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALSIGNUPTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALSIGNUPTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALUNKNOWNDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALUNKNOWNDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALUNKNOWNDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALUNKNOWNMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALUNKNOWNMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALUNKNOWNMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALUNKNOWNTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALUNKNOWNTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALUNKNOWNTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALVIDEO3SECVIEWS	Integer	True		No
TOTALVIDEOAVGWATCHTIMEINSECOND	String	True		No
TOTALVIDEOMRCVIEWS	Integer	True		No
TOTALVIDEOP0COMBINED	String	True		No
TOTALVIDEOP100COMPLETE	String	True		No
TOTALVIDEOP25COMBINED	String	True		No
TOTALVIDEOP50COMBINED	String	True		No
TOTALVIDEOP75COMBINED	String	True		No
TOTALVIDEOP95COMBINED	Integer	True		No
TOTALVIEWADDTOCART	Integer	True		No
TOTALVIEWADDTOCARTQUANTITY	Integer	True		No
TOTALVIEWADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWAPPINSTALL	Integer	True		No
TOTALVIEWAPPINSTALLVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWCATEGORYDESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALVIEWCATEGORYDESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALVIEWCATEGORYDESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALVIEWCATEGORYMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALVIEWCATEGORYMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALVIEWCATEGORYMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALVIEWCATEGORYTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALVIEWCATEGORYTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALVIEWCATEGORYTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALVIEWCHECKOUT	Integer	True		No
TOTALVIEWCHECKOUTQUANTITY	Integer	True		No
TOTALVIEWCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWCUSTOM	Integer	True		No
TOTALVIEWCUSTOMQUANTITY	Integer	True		No
TOTALVIEWCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWLEAD	Integer	True		No
TOTALVIEWLEADQUANTITY	Integer	True		No
TOTALVIEWLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWPAGEVISIT	Integer	True		No
TOTALVIEWPAGEVISITQUANTITY	Integer	True		No
TOTALVIEWPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWSEARCH	Integer	True		No
TOTALVIEWSEARCHQUANTITY	Integer	True		No
TOTALVIEWSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWSIGNUP	Integer	True		No
TOTALVIEWSIGNUPQUANTITY	Integer	True		No
TOTALVIEWSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWUNKNOWN	Integer	True		No
TOTALVIEWUNKNOWNQUANTITY	Integer	True		No
TOTALVIEWUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWVIEWCATEGORY	String	True		No
TOTALVIEWVIEWCATEGORYQUANTITY	Integer	True		No
TOTALVIEWVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALVIEWWATCHVIDEO	Integer	True		No
TOTALVIEWWATCHVIDEOQUANTITY	Integer	True		No
TOTALVIEWWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALWATCHVIDEODESKTOPACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALWATCHVIDEODESKTOPACTIONTOMOBILECONVERSION	Integer	True		No
TOTALWATCHVIDEODESKTOPACTIONTOTABLETCONVERSION	Integer	True		No
TOTALWATCHVIDEOMOBILEACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALWATCHVIDEOMOBILEACTIONTOMOBILECONVERSION	Integer	True		No
TOTALWATCHVIDEOMOBILEACTIONTOTABLETCONVERSION	Integer	True		No
TOTALWATCHVIDEOTABLETACTIONTODESKTOPCONVERSION	Integer	True		No
TOTALWATCHVIDEOTABLETACTIONTOMOBILECONVERSION	Integer	True		No
TOTALWATCHVIDEOTABLETACTIONTOTABLETCONVERSION	Integer	True		No
TOTALWEBADDTOCART	Integer	True		No
TOTALWEBADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCHECKOUT	Integer	True		No
TOTALWEBCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKADDTOCART	Integer	True		No
TOTALWEBCLICKADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKCHECKOUT	Integer	True		No
TOTALWEBCLICKCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKCUSTOM	Integer	True		No
TOTALWEBCLICKCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKLEAD	Integer	True		No
TOTALWEBCLICKLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKPAGEVISIT	Integer	True		No
TOTALWEBCLICKPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKSEARCH	Integer	True		No
TOTALWEBCLICKSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKSIGNUP	Integer	True		No
TOTALWEBCLICKSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKUNKNOWN	Integer	True		No
TOTALWEBCLICKUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKVIEWCATEGORY	String	True		No
TOTALWEBCLICKVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCLICKWATCHVIDEO	Integer	True		No
TOTALWEBCLICKWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBCUSTOM	Integer	True		No
TOTALWEBCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTADDTOCART	Integer	True		No
TOTALWEBENGAGEMENTADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTCHECKOUT	Integer	True		No
TOTALWEBENGAGEMENTCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTCUSTOM	Integer	True		No
TOTALWEBENGAGEMENTCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTLEAD	Integer	True		No
TOTALWEBENGAGEMENTLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTPAGEVISIT	Integer	True		No
TOTALWEBENGAGEMENTPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTSEARCH	Integer	True		No
TOTALWEBENGAGEMENTSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTSIGNUP	Integer	True		No
TOTALWEBENGAGEMENTSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTUNKNOWN	Integer	True		No
TOTALWEBENGAGEMENTUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTVIEWCATEGORY	String	True		No
TOTALWEBENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBENGAGEMENTWATCHVIDEO	Integer	True		No
TOTALWEBENGAGEMENTWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBLEAD	Integer	True		No
TOTALWEBLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBPAGEVISIT	Integer	True		No
TOTALWEBPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBSEARCH	Integer	True		No
TOTALWEBSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBSESSIONS	Integer	True		No
TOTALWEBSIGNUP	Integer	True		No
TOTALWEBSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBUNKNOWN	String	True		No
TOTALWEBUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWADDTOCART	Integer	True		No
TOTALWEBVIEWADDTOCARTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWCATEGORY	String	True		No
TOTALWEBVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWCHECKOUT	Integer	True		No
TOTALWEBVIEWCHECKOUTVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWCUSTOM	Integer	True		No
TOTALWEBVIEWCUSTOMVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWLEAD	Integer	True		No
TOTALWEBVIEWLEADVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWPAGEVISIT	Integer	True		No
TOTALWEBVIEWPAGEVISITVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWSEARCH	Integer	True		No
TOTALWEBVIEWSEARCHVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWSIGNUP	Integer	True		No
TOTALWEBVIEWSIGNUPVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWUNKNOWN	String	True		No
TOTALWEBVIEWUNKNOWNVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWVIEWCATEGORY	String	True		No
TOTALWEBVIEWVIEWCATEGORYVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBVIEWWATCHVIDEO	Integer	True		No
TOTALWEBVIEWWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
TOTALWEBWATCHVIDEO	Integer	True		No
TOTALWEBWATCHVIDEOVALUEINMICRODOLLAR	Integer	True		No
VIDEO3SECVIEWS1	String	True		No
VIDEO3SECVIEWS2	String	True		No
VIDEOAVGWATCHTIMEINSECOND1	String	True		No
VIDEOAVGWATCHTIMEINSECOND2	String	True		No
VIDEOLENGTH	String	True		No
VIDEOMRCVIEWS1	String	True		No
VIDEOMRCVIEWS2	String	True		No
VIDEOP0COMBINED1	String	True		No
VIDEOP0COMBINED2	String	True		No
VIDEOP100COMPLETE1	String	True		No
VIDEOP100COMPLETE2	String	True		No
VIDEOP25COMBINED1	String	True		No
VIDEOP25COMBINED2	String	True		No
VIDEOP50COMBINED1	String	True		No
VIDEOP50COMBINED2	String	True		No
VIDEOP75COMBINED1	String	True		No
VIDEOP75COMBINED2	String	True		No
VIDEOP95COMBINED1	String	True		No
VIDEOP95COMBINED2	String	True		No
WEBADDTOCARTCOSTPERACTION	Integer	True		No
WEBADDTOCARTROAS	String	True		No
WEBCHECKOUTCOSTPERACTION	String	True		No
WEBCHECKOUTROAS	String	True		No
WEBCUSTOMCOSTPERACTION	Integer	True		No
WEBCUSTOMROAS	String	True		No
WEBLEADCOSTPERACTION	Integer	True		No
WEBLEADROAS	String	True		No
WEBPAGEVISITCOSTPERACTION	Integer	True		No
WEBPAGEVISITROAS	String	True		No
WEBSEARCHCOSTPERACTION	Integer	True		No
WEBSEARCHROAS	String	True		No
WEBSESSIONS1	String	True		No
WEBSESSIONS2	String	True		No
WEBSIGNUPCOSTPERACTION	Integer	True		No
WEBSIGNUPROAS	String	True		No
WEBUNKNOWNCOSTPERACTION	Integer	True		No
WEBUNKNOWNROAS	String	True		No
WEBVIEWCATEGORYCOSTPERACTION	Integer	True		No
WEBVIEWCATEGORYROAS	String	True		No
WEBWATCHVIDEOCOSTPERACTION	Integer	True		No
WEBWATCHVIDEOROAS	String	True		No
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ConversionReportTime	String	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report
CampaignIds	String	False		Yes	Id of the campaign.
CampaignStatuses	String	False		Yes	List of status values for filtering
CampaignObjectiveTypes	String	False		Yes	List of status values for filtering
AdGroupIds	String	False		Yes	Id of the ad group.
AdGroupStatuses	String	False		Yes	List of values for filtering.
AdIds	String	False		Yes	List of ad ids
AdStatuses	String	False		Yes	List of values for filtering.
ProductGroupIds	String	False		Yes	List of product group ids.
ProductGroupStatuses	String	False		Yes	List of values for filtering.
TargetingTypes	String	False		Yes	Targeting type
AdsAnalyticsMetricsFilter	String	False		Yes	List of metrics filters
ProductItemIds	String	False		Yes	List of product item ids.
AdsAnalyticsMetricsFilter	String	False		Yes	List of metrics filters

Return to Top

AdAccounts

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Id of the Ad Account.
Name	String	True	No	Name of the Ad Account.
OwnerUsername	String	True	No	Owner Usernameof the Ad Account.
Country	String	True	No	Country of the ad account.
Currency	String	True	No	Currency of the ad account.
OwnerId	String	True	No	Owner UserId of the ad account.
CreatedTime	Datetime	True	No	Created Time of the ad account.
UpdatedTime	Datetime	True	No	Updated Time of the ad account.
Permissions	String	True	No	Permissions of the ad account.
IncludeSharedAccounts	Boolean	False	Yes	Include shared ad accounts

Return to Top

AdAccountTargetingAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
AdGroupId	String	True	AdGroups.Id	No	Id of the ad group.
TargetingType	String	True		No	Targeting type.
TargetingValues	String	True		No	Targeting type value.
Date	Date	True		No	Date the analytics row covers.
SpendInDollar	Decimal	True		No	Total spend in dollars.
AdvertiserId	Double	True		No	Id of the advertiser.
AdGroupEntityStatus	Double	True		No	Id of the advertiser.
AdId	Double	True		No	Id of the advertiser.
CampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
CampaignDailySpendCap	String	True		No	Campaign daily spend cap.
CampaignEntityStatus	String	True		No	Campaign entity status.
CampaignLifetimeSpendCap	Integer	True		No	Campaign Lifetime Spend Cap.
Ctr	Double	True		No	Ctr.
Ctr2	Double	True		No	Ctr2.
CheckoutRoas	Double	True		No	Checkout roas.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough2	Integer	True		No	Clickthrough2.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
CpcInMicroDollar	Decimal	True		No	Cpc In MicroDollar.
CpmInMicroDollar	Decimal	True		No	Cpm In MicroDollar.
Ectr	Decimal	True		No	Ectr.
EcpeInDollar	Decimal	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
EcpvInDollar	Decimal	True		No	Ecpv in dollars.
EcpcvInDollar	Decimal	True		No	E Cpcv in Dollars.
EcpcvP95InDollar	Decimal	True		No	E Cpcv 95 percent in Dollars.
EcpcInMicroDollar	Decimal	True		No	Ecpc In MicroDollar.
EcpmInMicroDollar	Decimal	True		No	Ecpm In MicroDollar.
Engagement1	Integer	True		No	Engagement1.
Engagement2	Integer	True		No	Engagement2.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
Impression2	Integer	True		No	Impression2.
IdeaPinProductTagVisit1	Integer	True		No	Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2	Integer	True		No	Idea Pin Product Tag Visit2.
InAppCheckoutCostPerAction	Double	True		No	In App Checkout Cost Per Action.
OutboundClick1	Integer	True		No	Outboundclick1.
OutboundClick2	Integer	True		No	Outboundclick2.
PinId	String	True	Pins.Id	No	Id of the Pins.
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
PaidImpression	Integer	True		No	PaidImpression.
Repin1	Integer	True		No	Repin1.
Repin2	Integer	True		No	Repin2.
RepinRate	Double	True		No	The repin rate.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Decimal	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Decimal	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Decimal	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Decimal	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Decimal	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Decimal	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Decimal	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Decimal	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Decimal	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Decimal	True		No	Total Web View Checkout Value In Micro Dollar.
Video3secViews2	Integer	True		No	Video 3 second Views.
VideoLength	Integer	True		No	VideoLength.
VideoMrcViews2	Integer	True		No	Video 2 second Views.
VideoP0Combined2	Integer	True		No	Video 0 percent Combined Views.
VideoP100Complete2	Integer	True		No	Video 100 percent Complete Views.
VideoP25Combined2	Integer	True		No	Video 25 percent Complete Views.
VideoP50Combined2	Integer	True		No	Video 50 percent Complete Views.
VideoP75Combined2	Integer	True		No	Video 75 percent Complete Views.
VideoP95Combined2	Integer	True		No	Video 95 percent Complete Views.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas.
WebSessions1	Integer	True		No	WebSessions1.
WebSessions2	Integer	True		No	WebSessions2.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report.
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	Integer	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

AdAnalytics

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

Return to Top

AdCampaignAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
CampaignId	String	True	Campaigns.Id	No	Id of the campaign.
AdAccountId	String	True	AdAccounts.Id	No	Id of the ad account.
Date	Date	True		No	Date the analytics row covers.
CampaignEntityStatus	String	True		No	Status of the campaign.
AdGroupEntityStatus	String	True		No	Status of the ad group.
SpendInDollar	Double	True		No	Total spend in dollars.
EcpcInDollar	Double	True		No	Ecpc in dollars.
Ctr	Double	True		No	Ctr.
Ectr	Double	True		No	Ectr.
EcpeInDollar	Double	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
RepinRate	Double	True		No	The repin rate.
Ctr2	Double	True		No	Ctr2
CpmInDollar	Double	True		No	Cpm in Dollars.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
CheckoutRoas	Double	True		No	Checkout roas.
Video3secViews2	Integer	True		No	Videos with at least 3 seconds of viewing.
VideoP100Complete2	Integer	True		No	Videos 100 percent complete
VideoP0Combined2	Integer	True		No	Videos 0 percent combined viewed.
VideoP25Combined2	Integer	True		No	Videos 25 percent combined viewed.
VideoP50Combined2	Integer	True		No	Video 50 percent combined viewed.
VideoP75Combined2	Integer	True		No	Video 75 percent combined viewed.
VideoP95Combined2	Integer	True		No	Video 95 percent combined viewed.
VideoMrcViews2	Integer	True		No	Video Mrc Views.
EcpvInDollar	Double	True		No	Ecpv in dollars.
EcpcvInDollar	Double	True		No	E Cpcv in Dollars
EcpcvP95InDollar	Double	True		No	E Cpcv 95 percent in Dollars.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalImpressionFrequency	Double	True		No	Total Impression Frequency.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Double	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Double	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Double	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Double	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Double	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Double	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Double	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Double	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Double	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Double	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Double	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Double	True		No	Total Web View Checkout Value In Micro Dollar.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
AdId	String	True	Ads.Id	No	Id of the Ad.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	String	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

AdGroupAnalytics

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

Return to Top

AdGroups

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Advertiser ID.
AdAccountId	String	True	AdAccounts.Id	No	Ad Account ID.
CampaignId	String	True	Campaigns.Id	No	Campaign ID of the ad group.
FeedProfileId	String	True		No	Feed Profile ID associated to the adgroup.
AutoTargetingEnabled	Boolean	True		No	Enable auto-targeting for ad group.
BidInMicroCurrency	Integer	True		No	Bid price in micro currency.
BillableEvent	String	True		No	Ad group billable event type.
BudgetInMicroCurrency	Integer	True		No	Budget in micro currency.
BudgetType	String	True		No	Budget type
ConversionLearningModeType	String	True		No	oCPM learn mode
CreatedTime	Datetime	True		No	Ad group creation time.
EndTime	Datetime	True		No	Ad group end time.
LifetimeFrequencyCap	Integer	True		No	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	True		No	Ad group name.
PacingDeliveryType	String	True		No	PacingDeliveryType
PlacementGroup	String	True		No	PlacementGroup
StartTime	Datetime	True		No	Ad group start time
Status	String	True		No	Ad group/entity status.
SummaryStatus	String	True		No	Ad group summary status.
TargetingSpec	String	True		No	Ad group targeting specification defining the ad group target audience.
TrackingUrlsAudienceVerification	String	True		No	Third-party tracking URLs.
TrackingUrlsBuyableButton	String	True		No	Third-party tracking URLs.
TrackingUrlsClick	String	True		No	Third-party tracking URLs.
TrackingUrlsEngagement	String	True		No	Third-party tracking URLs.
TrackingUrlsImpression	String	True		No	Third-party tracking URLs.
Type	String	True		No	Type of ad group.
UpdatedTime	Datetime	True		No	Ad group last update time.
TranslateInterestsToNames	Boolean	False		Yes	Return interests as text names and not topic IDs?

Return to Top

AdGroupTargetingAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
AdGroupId	String	True	AdGroups.Id	No	Id of the ad group.
TargetingType	String	True		No	Targeting type.
TargetingValues	String	True		No	Targeting type value.
Date	Date	True		No	Date the analytics row covers.
SpendInDollar	Decimal	True		No	Total spend in dollars.
AdvertiserId	Double	True		No	Id of the advertiser.
AdGroupEntityStatus	Double	True		No	Id of the advertiser.
AdId	Double	True		No	Id of the advertiser.
CampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
CampaignDailySpendCap	String	True		No	Campaign daily spend cap.
CampaignEntityStatus	String	True		No	Campaign entity status.
CampaignLifetimeSpendCap	Integer	True		No	Campaign Lifetime Spend Cap.
Ctr	Double	True		No	Ctr.
Ctr2	Double	True		No	Ctr2.
CheckoutRoas	Double	True		No	Checkout roas.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough2	Integer	True		No	Clickthrough2.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
CpcInMicroDollar	Decimal	True		No	Cpc In MicroDollar.
CpmInMicroDollar	Decimal	True		No	Cpm In MicroDollar.
Ectr	Decimal	True		No	Ectr.
EcpeInDollar	Decimal	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
EcpvInDollar	Decimal	True		No	Ecpv in dollars.
EcpcvInDollar	Decimal	True		No	E Cpcv in Dollars.
EcpcvP95InDollar	Decimal	True		No	E Cpcv 95 percent in Dollars.
EcpcInMicroDollar	Decimal	True		No	Ecpc In MicroDollar.
EcpmInMicroDollar	Decimal	True		No	Ecpm In MicroDollar.
Engagement1	Integer	True		No	Engagement1.
Engagement2	Integer	True		No	Engagement2.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
Impression2	Integer	True		No	Impression2.
IdeaPinProductTagVisit1	Integer	True		No	Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2	Integer	True		No	Idea Pin Product Tag Visit2.
InAppCheckoutCostPerAction	Double	True		No	In App Checkout Cost Per Action.
OutboundClick1	Integer	True		No	Outboundclick1.
OutboundClick2	Integer	True		No	Outboundclick2.
PinId	String	True	Pins.Id	No	Id of the Pins.
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
PaidImpression	Integer	True		No	PaidImpression.
Repin1	Integer	True		No	Repin1.
Repin2	Integer	True		No	Repin2.
RepinRate	Double	True		No	The repin rate.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Decimal	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Decimal	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Decimal	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Decimal	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Decimal	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Decimal	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Decimal	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Decimal	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Decimal	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Decimal	True		No	Total Web View Checkout Value In Micro Dollar.
Video3secViews2	Integer	True		No	Video 3 second Views.
VideoLength	Integer	True		No	VideoLength.
VideoMrcViews2	Integer	True		No	Video 2 second Views.
VideoP0Combined2	Integer	True		No	Video 0 percent Combined Views.
VideoP100Complete2	Integer	True		No	Video 100 percent Complete Views.
VideoP25Combined2	Integer	True		No	Video 25 percent Complete Views.
VideoP50Combined2	Integer	True		No	Video 50 percent Complete Views.
VideoP75Combined2	Integer	True		No	Video 75 percent Complete Views.
VideoP95Combined2	Integer	True		No	Video 95 percent Complete Views.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas.
WebSessions1	Integer	True		No	WebSessions1.
WebSessions2	Integer	True		No	WebSessions2.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report.
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	Integer	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	The ID of this ad.
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
AdGroupId	String	True	AdGroups.Id	No	ID of the ad group that contains the ad.
AndroidDeepLink	String	True		No	Deep link URL for Android devices. Not currently available. Using this field will generate an error.
CampaignId	String	True	Campaigns.Id	No	ID of the ad campaign that contains this ad.
CarouselAndroidDeepLinks	String	True		No	Comma-separated deep links for the carousel pin on Android.
CarouselDestinationUrls	String	True		No	Comma-separated destination URLs for the carousel pin to promote.
CarouselIosDeepLinks	String	True		No	Comma-separated deep links for the carousel pin on iOS.
ClickTrackingUrl	String	True		No	Tracking url for the ad clicks.
CollectionItemsDestinationUrlTemplate	String	True		No	Destination URL template for all items within a collections drawer.
CreatedTime	Datetime	True		No	Pin creation time.
CreativeType	String	True		No	Ad creative type
DestinationUrl	String	True		No	Destination URL.
IosDeepLink	String	True		No	Deep link URL for iOS devices.
IsPinDeleted	Boolean	True		No	Is original pin deleted?
IsRemovable	Boolean	True		No	Is pin repinnable?
Name	String	True		No	Name of the ad.
PinId	String	True		No	Pin ID.
RejectedReasons	String	True		No	Reason why the pin was rejected.
RejectionLabels	String	True		No	Text reason why the pin was rejected.
ReviewStatus	String	True		No	Ad review status
Status	String	True		No	Entity status
SummaryStatus	String	True		No	Ad summary status.
TrackingUrlsAudienceVerification	String	True		No	Tracking Urls Audience Verification.
TrackingUrlsBuyableButton	String	True		No	Tracking Urls Buyable Button.
TrackingUrlsClick	String	True		No	Tracking Urls Click.
TrackingUrlsEngagement	String	True		No	Tracking Urls Engagement.
TrackingUrlsImpression	String	True		No	Tracking Urls Impression.
Type	String	True		No	Type of ad.
UpdatedTime	Datetime	True		No	Last update time.
ViewTrackingUrl	String	True		No	Tracking URL for ad impressions.

Return to Top

AdsTargetingAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
AdId	String	True	Ads.Id	No	Id of the ad
TargetingType	String	True		No	Targeting type.
TargetingValues	String	True		No	Targeting type value.
Date	Date	True		No	Date the analytics row covers.
SpendInDollar	Decimal	True		No	Total spend in dollars.
AdvertiserId	Double	True		No	Id of the advertiser.
AdGroupEntityStatus	Double	True		No	Id of the advertiser.
MetricsAdId	String	True	Ads.Id	No	Id of the ad
CampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
CampaignDailySpendCap	String	True		No	Campaign daily spend cap.
CampaignEntityStatus	String	True		No	Campaign entity status.
CampaignLifetimeSpendCap	Integer	True		No	Campaign Lifetime Spend Cap.
Ctr	Double	True		No	Ctr.
Ctr2	Double	True		No	Ctr2.
CheckoutRoas	Double	True		No	Checkout roas.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough2	Integer	True		No	Clickthrough2.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
CpcInMicroDollar	Decimal	True		No	Cpc In MicroDollar.
CpmInMicroDollar	Decimal	True		No	Cpm In MicroDollar.
Ectr	Decimal	True		No	Ectr.
EcpeInDollar	Decimal	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
EcpvInDollar	Decimal	True		No	Ecpv in dollars.
EcpcvInDollar	Decimal	True		No	E Cpcv in Dollars.
EcpcvP95InDollar	Decimal	True		No	E Cpcv 95 percent in Dollars.
EcpcInMicroDollar	Decimal	True		No	Ecpc In MicroDollar.
EcpmInMicroDollar	Decimal	True		No	Ecpm In MicroDollar.
Engagement1	Integer	True		No	Engagement1.
Engagement2	Integer	True		No	Engagement2.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
Impression2	Integer	True		No	Impression2.
IdeaPinProductTagVisit1	Integer	True		No	Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2	Integer	True		No	Idea Pin Product Tag Visit2.
InAppCheckoutCostPerAction	Double	True		No	In App Checkout Cost Per Action.
OutboundClick1	Integer	True		No	Outboundclick1.
OutboundClick2	Integer	True		No	Outboundclick2.
PinId	String	True	Pins.Id	No	Id of the Pins.
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
PaidImpression	Integer	True		No	PaidImpression.
Repin1	Integer	True		No	Repin1.
Repin2	Integer	True		No	Repin2.
RepinRate	Double	True		No	The repin rate.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Decimal	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Decimal	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Decimal	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Decimal	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Decimal	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Decimal	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Decimal	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Decimal	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Decimal	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Decimal	True		No	Total Web View Checkout Value In Micro Dollar.
Video3secViews2	Integer	True		No	Video 3 second Views.
VideoLength	Integer	True		No	VideoLength.
VideoMrcViews2	Integer	True		No	Video 2 second Views.
VideoP0Combined2	Integer	True		No	Video 0 percent Combined Views.
VideoP100Complete2	Integer	True		No	Video 100 percent Complete Views.
VideoP25Combined2	Integer	True		No	Video 25 percent Complete Views.
VideoP50Combined2	Integer	True		No	Video 50 percent Complete Views.
VideoP75Combined2	Integer	True		No	Video 75 percent Complete Views.
VideoP95Combined2	Integer	True		No	Video 95 percent Complete Views.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas.
WebSessions1	Integer	True		No	WebSessions1.
WebSessions2	Integer	True		No	WebSessions2.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report.
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	Integer	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

AudienceInsights

Name	Type	ReadOnly	FilterOnly	Description
Type	String	True	No	Type of audience insights.
Date	Datetime	True	No	Generation date.
Size	Integer	True	No	Population count.
SizeIsUpperBound	Boolean	True	No	Indicates whether the audience size has been rounded up to the next highest upper boundary.
Categories	String	True	No	Categories.
Demographics	String	True	No	Audience demographics.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

AudienceInsightsScopeAndType

Name	Type	ReadOnly	FilterOnly	Description
Date	Datetime	True	No	Generation date.
Type	String	True	No	Type.
Scope	String	True	No	Scope.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

Audiences

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Audience ID.
AdAccountId	String	True	AdAccounts.Id	No	Ad account ID.
Name	String	True		No	Audience name.
AudienceType	String	True		No	Audience Types.
Description	String	True		No	Audience description.
RuleCountry	String	True		No	Valid countries include: US,CA, and GB.
RuleCustomerListId	String	True		No	Customer list ID. For CUSTOMER_LIST audience_type.
RuleEngagementDomain	String	True		No	Engagement domain.
RuleEngagementType	String	True		No	Engagement type enum. Optional for ENGAGEMENT audience_type.
RuleEvent	String	True		No	A Pinterest tag event. Optional for VISITOR audience_type.
RuleEventDataCurrency	String	True		No	Currency Codes from ISO 4217.
RuleEventDataLeadType	String	True		No	Promotion code.
RuleEventDataLineItemsProductBrand	String	True		No	Product brand.
RuleEventDataLineItemsProductCategory	String	True		No	Product category.
RuleEventDataLineItemsProductId	Integer	True		No	Product ID.
RuleEventDataLineItemsProductName	String	True		No	Product name.
RuleEventDataLineItemsProductPrice	String	True		No	Product price.
RuleEventDataLineItemsProductQuantity	Integer	True		No	Product quantity.
RuleEventDataLineItemsProductVariant	String	True		No	Product variant.
RuleEventDataLineItemsProductVariantId	String	True		No	Product variant ID.
RuleEventDataOrderId	String	True		No	Order ID.
RuleEventDataOrderQuantity	Integer	True		No	Order quantity.
RuleEventDataPageName	String	True		No	Page name.
RuleEventDataPromoCode	String	True		No	Promotion code.
RuleEventDataProperty	String	True		No	Property.
RuleEventDataSearchQuery	String	True		No	Search query string.
RuleEventDataValue	String	True		No	Product value.
RuleEventDataVideoTitle	String	True		No	Video title.
RulePercentage	Integer	True		No	Percentage should be 1-10. The targeted audience should be this % size across Pinterest.
RulePinId	String	True		No	Pin Id.
RulePrefill	Boolean	True		No	Optional for VISITOR audience_type. The default is true.
RuleRetentionDays	Integer	True		No	Number of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR audience_type.
RuleSeedId	String	True		No	Seed Id.
RuleUrl	String	True		No	Url.
RuleVisitorSourceId	String	True		No	The conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR audience_type.
RuleEventSource	String	True		No	Optional for VISITOR. You can use it as a {'=': [value]}.
RuleIngestionSource	String	True		No	Optional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api
RuleEngagerType	Integer	True		No	Optional for ENGAGEMENT. Engager type value should be 1-2.
RuleCampaignId	String	True		No	Campaign Id.
RuleAdId	String	True		No	Ad Id.
RuleObjectiveType	String	True		No	Objective Type.
RuleAdAccountId	String	True		No	Ad account ID.
Size	Integer	True		No	Audience size.
Status	String	True		No	Audience status.
Type	String	True		No	Always
CreatedTime	Datetime	True		No	Creation time. Unix timestamp in seconds.
UpdatedTime	Datetime	True		No	Last update time. Unix timestamp in seconds.

Return to Top

Boards

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	Id of the Board
Name	String	True	No	Name of the Board
Description	String	True	No	Description of the Board
OwnerUsername	String	True	No	UserName of the Owner.
Privacy	String	True	No	Privacy setting for the board.
MediaImageCoverUrl	String	True	No	Media image cover url for the board.
MediaPinThumbnailUrls	String	True	No	Pin thumbnail urls for the board.
PinCount	Integer	True	No	Pin count.
FollowerCount	Integer	True	No	Follower count.
CollaboratorCount	Integer	True	No	Collaborator count.
CreatedAt	Datetime	True	No	Created Time.
BoardPinsModifiedAt	Datetime	True	No	Modified Time.

Return to Top

BoardSections

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Id of the Section.
Name	String	True		No	Name of the Section.
BoardId	String	True	Boards.Id	No	Id of the Board.

Return to Top

Campaigns

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Campaign ID.
AdAccountId	String	True	AdAccounts.Id	No	Campaign's Advertiser ID.
CreatedTime	Datetime	True		No	Campaign creation time.
DailySpendCap	Integer	True		No	Campaign total spending cap.
LifetimeSpendCap	Integer	True		No	Campaign daily spending cap.
Name	String	True		No	Campaign name.
ObjectiveType	String	True		No	Campaign objective type.
OrderLineId	String	True		No	Order line ID that appears on the invoice.
Status	String	True		No	Entity status.
TrackingUrlsAudienceVerification	String	True		No	Tracking Urls Audience Verification.
TrackingUrlsBuyableButton	String	True		No	Tracking Urls Buyable Button.
TrackingUrlsClick	String	True		No	Tracking Urls Click.
TrackingUrlsEngagement	String	True		No	Tracking Urls Engagement
TrackingUrlsImpression	String	True		No	Tracking Urls Impression.
Type	String	True		No	Type of campaign.
UpdatedTime	Datetime	True		No	Last update time.
StartTime	Datetime	True		No	Start time.
EndTime	Datetime	True		No	End time.
SummaryStatus	String	True		No	Summary status.
IsFlexibleDailyBudgets	Boolean	True		No	Is Flexible Daily Budgets.
IsCampaignBudgetOptimization	Boolean	True		No	Is Campaign Budget Optimization.

Return to Top

CampaignTargetingAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
TargetingType	String	True		No	Targeting type.
CampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
TargetingValues	String	True		No	Targeting type value.
Date	Date	True		No	Date the analytics row covers.
SpendInDollar	Decimal	True		No	Total spend in dollars.
AdvertiserId	Double	True		No	Id of the advertiser.
AdGroupEntityStatus	Double	True		No	Id of the advertiser.
AdId	Double	True		No	Id of the advertiser.
MetricCampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
CampaignDailySpendCap	String	True		No	Campaign daily spend cap.
CampaignEntityStatus	String	True		No	Campaign entity status.
CampaignLifetimeSpendCap	Integer	True		No	Campaign Lifetime Spend Cap.
Ctr	Double	True		No	Ctr.
Ctr2	Double	True		No	Ctr2.
CheckoutRoas	Double	True		No	Checkout roas.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough2	Integer	True		No	Clickthrough2.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
CpcInMicroDollar	Decimal	True		No	Cpc In MicroDollar.
CpmInMicroDollar	Decimal	True		No	Cpm In MicroDollar.
Ectr	Decimal	True		No	Ectr.
EcpeInDollar	Decimal	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
EcpvInDollar	Decimal	True		No	Ecpv in dollars.
EcpcvInDollar	Decimal	True		No	E Cpcv in Dollars.
EcpcvP95InDollar	Decimal	True		No	E Cpcv 95 percent in Dollars.
EcpcInMicroDollar	Decimal	True		No	Ecpc In MicroDollar.
EcpmInMicroDollar	Decimal	True		No	Ecpm In MicroDollar.
Engagement1	Integer	True		No	Engagement1.
Engagement2	Integer	True		No	Engagement2.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
Impression2	Integer	True		No	Impression2.
IdeaPinProductTagVisit1	Integer	True		No	Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2	Integer	True		No	Idea Pin Product Tag Visit2.
InAppCheckoutCostPerAction	Double	True		No	In App Checkout Cost Per Action.
OutboundClick1	Integer	True		No	Outboundclick1.
OutboundClick2	Integer	True		No	Outboundclick2.
PinId	String	True	Pins.Id	No	Id of the Pins.
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
PaidImpression	Integer	True		No	PaidImpression.
Repin1	Integer	True		No	Repin1.
Repin2	Integer	True		No	Repin2.
RepinRate	Double	True		No	The repin rate.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Decimal	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Decimal	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Decimal	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Decimal	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Decimal	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Decimal	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Decimal	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Decimal	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Decimal	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Decimal	True		No	Total Web View Checkout Value In Micro Dollar.
Video3secViews2	Integer	True		No	Video 3 second Views.
VideoLength	Integer	True		No	VideoLength.
VideoMrcViews2	Integer	True		No	Video 2 second Views.
VideoP0Combined2	Integer	True		No	Video 0 percent Combined Views.
VideoP100Complete2	Integer	True		No	Video 100 percent Complete Views.
VideoP25Combined2	Integer	True		No	Video 25 percent Complete Views.
VideoP50Combined2	Integer	True		No	Video 50 percent Complete Views.
VideoP75Combined2	Integer	True		No	Video 75 percent Complete Views.
VideoP95Combined2	Integer	True		No	Video 95 percent Complete Views.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas.
WebSessions1	Integer	True		No	WebSessions1.
WebSessions2	Integer	True		No	WebSessions2.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report.
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	Integer	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

CatalogHotelReport

Name	Type	ReadOnly	FilterOnly	Description
CatalogId	String	True	No	Unique identifier of a catalog.
CatalogName	String	True	No	CatalogName.
DataSourceId	String	True	No	DataSourceId.
DataSourceName	String	True	No	DataSourceName.
MerchantHotelId	String	True	No	MerchantHotelId.
Name	String	True	No	Name.
IneligibleForOrganic	String	True	No	IneligibleForOrganic.
IneligibleForAds	String	True	No	IneligibleForAds.
CodeLabel	String	True	No	CodeLabel.
Message	String	True	No	Message.
Link	String	True	No	Link.
ImageLink	String	True	No	ImageLink.
CatalogType	String	False	Yes	Type of the catalog entity.
ReportType	String	False	Yes	Report Type.
FeedId	String	False	Yes	ID of the feed entity.
ProcessingResultId	String	False	Yes	Unique identifier of a feed processing result.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

CatalogProcessingResultItemIssues

Name	Type	ReadOnly	References	FilterOnly	Description
ItemId [KEY]	String	True		No	The merchant-created unique ID that represents the product.
FeedProcessingResultId	String	True	FeedProcessingResults.Id	No	Unique identifier of a feed processing result.
ItemNumber	Integer	True		No	Item number based on order of appearance in the Catalogs Feed.
ErrorAdultInvalidName	String	True		No	Item attribute that has an invalid adult value.
ErrorAdultInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorAdwordsFormatInvalidName	String	True		No	Item has an ad link URL that is duplicate of the link URL.
ErrorAdwordsFormatInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorAvailabilityInvalidName	String	True		No	Item is missing availability value in its product metadata, this item will not be published.
ErrorAvailabilityInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorBlocklistedImageSignatureName	String	True		No	Item will not be published because it doesn't meet Pinterest's Merchant Guidelines.
ErrorBlocklistedImageSignatureValue	String	True		No	Provided value that caused the validation issue.
ErrorDescriptionMissingName	String	True		No	Item is missing description in its product metadata, this item will not be published.
ErrorDescriptionMissingValue	String	True		No	Provided value that caused the validation issue.
ErrorDuplicateProductsName	String	True		No	This product is duplicated. The duplicate entry will not be published.
ErrorDuplicateProductsValue	String	True		No	Provided value that caused the validation issue.
ErrorImageLinkInvalidName	String	True		No	Image link is invalid.
ErrorImageLinkInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorImageLinkLengthTooLongName	String	True		No	Item has image_link URL that contains too many characters, so the item will not be published.
ErrorImageLinkLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
ErrorImageLinkMissingName	String	True		No	Item is missing an image link URL in its product metadata, this item will not be published.
ErrorImageLinkMissingValue	String	True		No	Provided value that caused the validation issue.
ErrorInvalidDomainName	String	True		No	Product link value doesn't match the verified domain associated with this account.
ErrorInvalidDomainValue	String	True		No	Provided value that caused the validation issue.
ErrorItemIdMissingName	String	True		No	Item is missing item id in its product metadata, this item will not be published.
ErrorItemIdMissingValue	String	True		No	Provided value that caused the validation issue.
ErrorItemMainImageDownloadFailureName	String	True		No	Main image can't be found.
ErrorItemMainImageDownloadFailureValue	String	True		No	Provided value that caused the validation issue.
ErrorLinkFormatInvalidName	String	True		No	Link is invalid.
ErrorLinkFormatInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorLinkLengthTooLongName	String	True		No	Product link contains too many characters, this item will not be published.
ErrorLinkLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
ErrorListPriceInvalidName	String	True		No	Item has a list price formatting error, this item will not be published.
ErrorListPriceInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorMaxItemsPerItemGroupExceededName	String	True		No	Item exceed the maximum number of items per item group, this item will not be published.
ErrorMaxItemsPerItemGroupExceededValue	String	True		No	Provided value that caused the validation issue.
ErrorParseLineErrorName	String	True		No	Item contains formating errors.
ErrorParseLineErrorValue	String	True		No	Provided value that caused the validation issue.
ErrorPinJoinContentUnsafeName	String	True		No	Item will not be published because it doesn't meet Pinterest's Merchant Guidelines.
ErrorPinJoinContentUnsafeValue	String	True		No	Provided value that caused the validation issue.
ErrorPriceCannotBeDeterminedName	String	True		No	Item price cannot be determined because the price, list price, and sale price are all different.
ErrorPriceCannotBeDeterminedValue	String	True		No	Provided value that caused the validation issue.
ErrorPriceMISSINGName	String	True		No	Product is missing a price, this item will not be published.
ErrorPriceMISSINGValue	String	True		No	Provided value that caused the validation issue.
ErrorProductLinkMissingName	String	True		No	Item is missing a link URL in its product metadata, this item will not be published.
ErrorProductLinkMissingValue	String	True		No	Provided value that caused the validation issue.
ErrorProductPriceInvalidName	String	True		No	Item has a price formatting error in its product metadata, this item will not be published.
ErrorProductPriceInvalidValue	String	True		No	Provided value that caused the validation issue.
ErrorTitleMissingName	String	True		No	Item is missing title in its product metadata, this item will not be published.
ErrorTitleMissingValue	String	True		No	Provided value that caused the validation issue.
WarningAdLinkFormatWarningName	String	True		No	Item has an ad link that is formatted incorrectly.
WarningAdLinkFormatWarningValue	String	True		No	Provided value that caused the validation issue.
WarningAdLinkSameAsLinkName	String	True		No	Item has an ad link URL that is duplicate of the link URL.
WarningAdLinkSameAsLinkValue	String	True		No	Provided value that caused the validation issue.
WarningAdditionalImageLinkLengthTooLongName	String	True		No	Item has an additional_image_link URL that contains too many characters, so the item will not be published.
WarningAdditionalImageLinkLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
WarningAdditionalImageLinkWarningName	String	True		No	Item has additional_image_link URLs that are formatted incorrectly and will not be published with your items.
WarningAdditionalImageLinkWarningValue	String	True		No	Provided value that caused the validation issue.
WarningAdwordsFormatWarningName	String	True		No	Item has an adwords_redirect link that is formatted incorrectly.
WarningAdwordsFormatWarningValue	String	True		No	Provided value that caused the validation issue.
WarningAdwordsSameAsLinkName	String	True		No	Item has an adwords_redirect URL that is duplicate of the link URL.
WarningAdwordsSameAsLinkValue	String	True		No	Provided value that caused the validation issue.
WarningAgeGroupInvalidName	String	True		No	Item has an age group value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningAgeGroupInvalidDValue	String	True		No	Provided value that caused the validation issue.
WarningSizeSystemInvalidName	String	True		No	Some items have size system values which are not one of the supported size systems.
WarningSizeSystemInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningAndroidDeepLinkInvalidName	String	True		No	Item includes an invalid android_deep_link.
WarningAndroidDeepLinkInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningAvailabilityDateInvalidName	String	True		No	Item has an availability_date value that is formatted incorrectly, this item will be published without an availability date.
WarningAvailabilityDateInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningConutryDoesNotMapToCurrencyName	String	True		No	Item includes a currency that doesn't match the usual currency for the location where the product is sold or shipped.
WarningCountryDoesNotMapToCurrencyValue	String	True		No	Provided value that caused the validation issue.
WarningCustomLabelLengthTooLongName	String	True		No	Item has a custom_label value that is too long, this item will be published without that custom label.
WarningCustomLabelLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
WarningDescriptionLengthTooLongName	String	True		No	The description for this item was truncated because it contains too many characters.
WarningDescriptionLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
WarningExpirationDateInvalidName	String	True		No	Item has an expiration_date value that is formatted incorrectly, this item will be published without an expiration date.
WarningExpirationDateInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningGenderInvalidName	String	True		No	Item has a gender value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningGenderInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningGTINInvalidName	String	True		No	Item has a GTIN value that is formatted incorrectly.
WarningGTINInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningImageLinkWarningName	String	True		No	Item has an image_link URL that is formatted incorrectly and will not be published.
WarningImageLinkWarningValue	String	True		No	Provided value that caused the validation issue.
WarningIOSDeepLinkInvalidName	String	True		No	Item includes an invalid ios_deep_link value.
WarningIOSDeepLinkInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningIsBundleInvalidName	String	True		No	Item has an is_bundle value that is formatted incorrectly, this item will be published without being bundled with other products.
WarningIsBundleInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningItemAdditionalImageDownloadFailureName	String	True		No	Item includes additional_image_links that can't be found.
WarningItemAdditionalImageDownloadFailureValue	String	True		No	Provided value that caused the validation issue.
WarningLinkFormatWarningName	String	True		No	Item has an invalid product link which contains invalid UTM tracking paramaters.
WarningLinkFormatWarningValue	String	True		No	Provided value that caused the validation issue.
WarningMinAdPriceInvalidName	String	True		No	Item includes a min_ad_price value that is formatted incorrectly.
WarningMinAdPriceInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningMPNInvalidName	String	True		No	Item has a MPN value that is formatted incorrectly.
WarningMPNInvalidValue	String	True		No	Provided value that caused the validation issue..
WarningMultipackInvalidName	String	True		No	Item has an invalid multipack value.
WarningMultipackInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningOptionalConditionInvalidName	String	True		No	Item includes a condition value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningOptionalConditionInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningOptionalConditionMissingName	String	True		No	Item is missing condition value, which may limit visibility in recommendations, search results and shopping experiences.
WarningOptionalConditionMissingValue	String	True		No	Provided value that caused the validation issue.
WarningOptionalProductCategoryInvalidName	String	True		No	Item includes a google_product_category value that is not formatted correctly according to the GPC taxonomy.
WarningOptionalProductCategoryInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningOptionalProductCategoryMissingName	String	True		No	Item is missing google_product_category.
WarningOptionalProductCategoryMissingValue	String	True		No	Provided value that caused the validation issue.
WarningProductCategoryDepthWarningName	String	True		No	Item only has 1 or 2 levels of google_product_category value, which may limit visibility in recommendations, search results and shopping experiences.
WarningProductCategoryDepthWarningValue	String	True		No	Provided value that caused the validation issue.
WarningProductTypeLengthTooLongName	String	True		No	Item has a product_type value that is too long, this item will be published without that product type.
WarningProductTypeLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
WarningSalesPriceInvalidName	String	True		No	Item has an incorrectly formatted sales price.
WarningSalesPriceInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningSalesPriceTooLowName	String	True		No	Item has a sale price value that is discounted very low compared to the price.
WarningSalesPriceTooLowValue	String	True		No	Provided value that caused the validation issue.
WarningSalesPriceTooHighName	String	True		No	Item has a sale price value that is higher than the original price of the item.
WarningSalesPriceTooHighValue	String	True		No	Provided value that caused the validation issue.
WarningSaleDateInvalidName	String	True		No	Item has a sale_price_effective_date value that is formatted incorrectly, this item will be published without a sale date.
WarningSaleDateInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningShippingInvalidName	String	True		No	Item has a shipping value that is formatted incorrectly.
WarningShippingInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningShippingHeightInvalidName	String	True		No	Item has an incorrectly formatted shipping_height value. The value must first contain a numeric value then a valid dimension unit type.
WarningShippingHeightInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningShippingWeightInvalidName	String	True		No	Item has an invalid shipping_weight value.
WarningShippingWeightInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningShippingWidthInvalidName	String	True		No	Item has an incorrectly formatted shipping_width value. The value must first contain a numeric value then a valid dimension unit type.
WarningShippingWidthInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningSizeTypeInvalidName	String	True		No	Item has a size type value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningSizeTypeInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningTaxInvalidName	String	True		No	Item has a tax value that is formatted incorrectly.
WarningTaxInvalidValue	String	True		No	Provided value that caused the validation issue.
WarningTitleLengthTooLongName	String	True		No	The title for the item was truncated because it contains too many characters.
WarningTitleLengthTooLongValue	String	True		No	Provided value that caused the validation issue.
WarningTooManyAdditionalImageLinksName	String	True		No	Item has a additional_image_link value that exceed the limit for additional images, this item will be published without some of your images.
WarningTooManyAdditionalImageLinksValue	String	True		No	Provided value that caused the validation issue.
WarningUTMSourceAutoCorrectedName	String	True		No	Item includes an utm_source value that is formatted incorrectly and has been automatically corrected.
WarningUTMSourceAutoCorrectedValue	String	True		No	Provided value that caused the validation issue.
WarningWeightUnitInvalidName	String	True		No	Item has a weight_unit value that is formatted incorrectly, this item will be published without a weight unit.
WarningWeightUnitInvalidValue	String	True		No	Provided value that caused the validation issue.
AdAccountId	String	False		Yes	Unique identifier of an ad account.
ItemValidationIssue	String	False		Yes	Filter item validation issues that have a given type of item validation issue.

Return to Top

CatalogRetailReport

Name	Type	ReadOnly	FilterOnly	Description
CatalogId	String	True	No	Unique identifier of a catalog.
CatalogName	String	True	No	CatalogName.
DataSourceId	String	True	No	DataSourceId.
DataSourceName	String	True	No	DataSourceName.
ItemId	String	True	No	ItemId.
Title	String	True	No	Title.
IneligibleForOrganic	String	True	No	IneligibleForOrganic.
IneligibleForAds	String	True	No	IneligibleForAds.
CodeLabel	String	True	No	CodeLabel.
Message	String	True	No	Message.
Link	String	True	No	Link.
ImageLink	String	True	No	ImageLink.
Price	String	True	No	Price.
Availability	String	True	No	Availability.
CatalogType	String	False	Yes	Type of the catalog entity.
ReportType	String	False	Yes	Report Type.
FeedId	String	False	Yes	ID of the feed entity.
ProcessingResultId	String	False	Yes	Unique identifier of a feed processing result.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

Catalogs

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	ID of the catalog entity.
Name	String	True	No	A human-friendly name associated to a catalog entity.
CreatedAt	Datetime	True	No	CreatedAt time.
UpdatedAt	Datetime	True	No	UpdatedAt time.
CatalogType	String	True	No	Type of the catalog entity.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

CatalogTypeCreativeAssetsItems

Name	Type	ReadOnly	FilterOnly	Description
CreativeAssetsId	String	True	No	The catalog creative assets id in the merchant namespace.
CatalogType	String	True	No	Type of the catalog entity.
CatalogId	String	True	No	Catalog id pertaining to the creative assets item. If not provided, default to oldest creative assets catalog.
Country	String	True	No	Country ID from ISO 3166-1 alpha-2.
Language	String	True	No	Catalog Language.
AttributesAdditionalImagelink	String	True	No	The links to additional images for your product.Must start with http:// or https://.
AttributesImageLink	String	True	No	The creative assets image.Must start with http:// or https://.
AttributesVideoLink	String	True	No	The creative assets video.
AttributesAdLink	String	True	No	Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only.Must start with http:// or https://.
AttributesAdult	Boolean	True	No	Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroup	String	True	No	The age group to apply a demographic range to the product.
AttributesAvailability	String	True	No	The availability of the product.
AttributesAverageReviewRating	Integer	True	No	Average reviews for the item. Can be a number from 1-5.
AttributesBrand	String	True	No	The brand of the product.
AttributesColor	String	True	No	The primary color of the product.
AttributesCondition	String	True	No	The condition of the product.
AttributesCustomLabel0	String	True	No	Custom grouping of creative assets.
AttributesCustomLabel1	String	True	No	Custom grouping of creative assets.
AttributesCustomLabel2	String	True	No	Custom grouping of creative assets.
AttributesCustomLabel3	String	True	No	Custom grouping of creative assets.
AttributesCustomLabel4	String	True	No	Custom grouping of creative assets.
AttributesCustomNumber0	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescription	String	True	No	Brief description of the creative assets..
AttributesFreeShippingLabel	Boolean	True	No	The item is free to ship.
AttributesFreeShippingLimit	String	True	No	The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGender	String	True	No	The gender associated with the product.
AttributesGoogleProductCategory	String	True	No	The categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtin	Long	True	No	The unique universal product identifier.
AttributesItemGroupId	String	True	No	The parent ID of the product.
AttributesLastUpdatedTime	Datetime	True	No	The millisecond timestamp when the item was lastly modified by the merchant.
AttributesLink	String	True	No	Link to the creative assets page.
AttributesMaterial	String	True	No	The material used to make the product.
AttributesMinAdPrice	String	True	No	The minimum advertised price of the product.
AttributesMobileLink	String	True	No	The mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpn	String	True	No	Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatings	Integer	True	No	The number of ratings for the item.
AttributesNumberOfReviews	Integer	True	No	The number of reviews available for the item.
AttributesPattern	String	True	No	The description of the pattern used for the product.
AttributesPrice	String	True	No	The price of the product.
AttributesProductType	String	True	No	The categorization of your product based on your custom product taxonomy.
AttributesSalePrice	String	True	No	The discounted price of the product. The sale_price must be lower than the price.
AttributesShipping	String	True	No	Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeight	String	True	No	The height of the package needed to ship the product.
AttributesShippingWeight	String	True	No	The weight of the product.
AttributesShippingWidth	String	True	No	The width of the package needed to ship the product.
AttributesSize	String	True	No	The size of the product.
AttributesSizeSystem	String	True	No	Indicates the country’s sizing system in which you are submitting your product.
AttributesSizeType	String	True	No	Additional description for the size.
AttributesTax	String	True	No	Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitle	String	True	No	The name of the creative assets.
AttributesVariantNames	String	True	No	Options for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValues	String	True	No	Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed.
AttributesIosDeepLink	String	True	No	IOS deep link to the creative assets page.
AttributesAndroidDeepLink	String	True	No	Link to the creative assets page.
AttributesVisibility	String	True	No	Visibility of the creative assets.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

CatalogTypeHotelItems

Name	Type	ReadOnly	FilterOnly	Description
HotelId	String	True	No	The catalog hotel id in the merchant namespace.
CatalogType	String	True	No	Type of the catalog entity.
CatalogId	String	True	No	Catalog id pertaining to the hotel item. If not provided, default to oldest hotel catalog.
Country	String	True	No	Country ID from ISO 3166-1 alpha-2.
Language	String	True	No	Catalog Language.
AttributesAdditionalImagelink	String	True	No	The links to additional images for your hotel. Up to ten additional images can be used to show a hotel from different angles. Must begin with http:// or https://.
AttributesImageLink	String	True	No	The link to the main product images.Must start with http:// or https://.
AttributesVideoLink	String	True	No	Hosted link to the product video.
AttributesAdLink	String	True	No	Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only.Must start with http:// or https://.
AttributesAdult	Boolean	True	No	Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroup	String	True	No	The age group to apply a demographic range to the product.
AttributesAvailability	String	True	No	The availability of the product.
AttributesAverageReviewRating	Integer	True	No	Average reviews for the item. Can be a number from 1-5.
AttributesBrand	String	True	No	The brand of the product.
AttributesColor	String	True	No	The primary color of the product.
AttributesCondition	String	True	No	The condition of the product.
AttributesCustomLabel0	String	True	No	Custom grouping of hotels.
AttributesCustomLabel1	String	True	No	Custom grouping of hotels.
AttributesCustomLabel2	String	True	No	Custom grouping of hotels.
AttributesCustomLabel3	String	True	No	Custom grouping of hotels.
AttributesCustomLabel4	String	True	No	Custom grouping of hotels.
AttributesCustomNumber0	Integer	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescription	String	True	No	Brief description of the hotel.
AttributesFreeShippingLabel	Boolean	True	No	The item is free to ship.
AttributesFreeShippingLimit	String	True	No	The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGender	String	True	No	The gender associated with the product.
AttributesGoogleProductCategory	String	True	No	The categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtin	Long	True	No	The unique universal product identifier.
AttributesItemGroupId	String	True	No	The parent ID of the product.
AttributesLastUpdatedTime	Datetime	True	No	The millisecond timestamp when the item was lastly modified by the merchant.
AttributesLink	String	True	No	The landing page for the product.
AttributesMaterial	String	True	No	The material used to make the product.
AttributesMinAdPrice	String	True	No	The minimum advertised price of the product.
AttributesMobileLink	String	True	No	The mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpn	String	True	No	Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatings	Integer	True	No	The number of ratings for the item.
AttributesNumberOfReviews	Integer	True	No	The number of reviews available for the item.
AttributesPattern	String	True	No	The description of the pattern used for the product.
AttributesPrice	String	True	No	The price of the product.
AttributesProductType	String	True	No	The categorization of your product based on your custom product taxonomy.
AttributesSalePrice	String	True	No	The discounted price of the product. The sale_price must be lower than the price.
AttributesShipping	String	True	No	Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeight	String	True	No	The height of the package needed to ship the product.
AttributesShippingWeight	String	True	No	The weight of the product.
AttributesShippingWidth	String	True	No	The width of the package needed to ship the product.
AttributesSize	String	True	No	The size of the product.
AttributesSizeSystem	String	True	No	Indicates the country’s sizing system in which you are submitting your product.
AttributesSizeType	String	True	No	Additional description for the size.
AttributesTax	String	True	No	Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitle	String	True	No	The title of the product.
AttributesVariantNames	String	True	No	Options for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValues	String	True	No	Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed.
AttributesMainImageLink	String	True	No	The link to the main hotel image. Image should be at least 75x75 pixels to avoid errors. Use the additional_image_link field to add more images of your hotel.
AttributesMainImageTag	String	True	No	Tag appended to the image that identifies image category or details. There can be multiple tags associated with an image.
AttributesLatitude	Integer	True	No	Latitude of the hotel.
AttributesLongitude	Integer	True	No	Longitude of the hotel.
AttributesNeighborhood	String	True	No	A list of neighborhoods where the hotel is located.
AttributesAddressAddr1	String	True	No	Primary street address of hotel.
AttributesAddressCity	String	True	No	City where the hotel is located.
AttributesAddressRegion	String	True	No	State, county, province, where the hotel is located.
AttributesAddressCountry	String	True	No	Country where the hotel is located.
AttributesAddressPostalCode	String	True	No	Required for countries with a postal code system. Postal or zip code of the hotel.
AttributesCategory	String	True	No	The type of property. The category can be any type of internal description desired.
AttributesBasePrice	String	True	No	Base price of the hotel room per night followed by the ISO currency code.
AttributesGuestRatingsScore	Integer	True	No	Your hotel's rating.
AttributesGuestRatingsNumberOfReviewers	Integer	True	No	Total number of people who have rated this hotel.
AttributesGuestRatingsMaxScore	Integer	True	No	Max value for the hotel rating score.
AttributesGuestRatingSystem	String	True	No	System you use for guest reviews.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

CatalogTypeRetailItems

Name	Type	ReadOnly	FilterOnly	Description
RetailItemId	String	True	No	The catalog retail item id in the merchant namespace.
CatalogType	String	True	No	Type of the catalog entity.
CatalogId	String	True	No	Catalog id pertaining to the retail item. If not provided, default to oldest retail catalog.
Country	String	True	No	Country ID from ISO 3166-1 alpha-2.
Language	String	True	No	Catalog Language.
AttributesAdditionalImagelink	String	True	No	The links to additional images for your product.Must start with http:// or https://.
AttributesImageLink	String	True	No	The link to the main product images.Must start with http:// or https://.
AttributesVideoLink	String	True	No	Hosted link to the product video.
AttributesAdLink	String	True	No	Allows advertisers to specify a separate URL that can be used to track traffic coming from Pinterest shopping ads. Must send full URL including tracking—do not send tracking parameters only.Must start with http:// or https://.
AttributesAdult	Boolean	True	No	Set this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroup	String	True	No	The age group to apply a demographic range to the product.
AttributesAvailability	String	True	No	The availability of the product.
AttributesAverageReviewRating	Integer	True	No	Average reviews for the item. Can be a number from 1-5.
AttributesBrand	String	True	No	The brand of the product.
AttributesColor	String	True	No	The primary color of the product.
AttributesCondition	String	True	No	The condition of the product.
AttributesCustomLabel0	String	True	No	Custom grouping of products.
AttributesCustomLabel1	String	True	No	Custom grouping of products.
AttributesCustomLabel2	String	True	No	Custom grouping of products.
AttributesCustomLabel3	String	True	No	Custom grouping of products.
AttributesCustomLabel4	String	True	No	Custom grouping of products.
AttributesCustomNumber0	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4	Long	True	No	An attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescription	String	True	No	The description of the product.
AttributesFreeShippingLabel	Boolean	True	No	The item is free to ship.
AttributesFreeShippingLimit	String	True	No	The minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGender	String	True	No	The gender associated with the product.
AttributesGoogleProductCategory	String	True	No	The categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtin	Long	True	No	The unique universal product identifier.
AttributesItemGroupId	String	True	No	The parent ID of the product.
AttributesLastUpdatedTime	Datetime	True	No	The millisecond timestamp when the item was lastly modified by the merchant.
AttributesLink	String	True	No	The landing page for the product.
AttributesMaterial	String	True	No	The material used to make the product.
AttributesMinAdPrice	String	True	No	The minimum advertised price of the product.
AttributesMobileLink	String	True	No	The mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpn	String	True	No	Manufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatings	Integer	True	No	The number of ratings for the item.
AttributesNumberOfReviews	Integer	True	No	The number of reviews available for the item.
AttributesPattern	String	True	No	The description of the pattern used for the product.
AttributesPrice	String	True	No	The price of the product.
AttributesProductType	String	True	No	The categorization of your product based on your custom product taxonomy.
AttributesSalePrice	String	True	No	The discounted price of the product. The sale_price must be lower than the price.
AttributesShipping	String	True	No	Shipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeight	String	True	No	The height of the package needed to ship the product.
AttributesShippingWeight	String	True	No	The weight of the product.
AttributesShippingWidth	String	True	No	The width of the package needed to ship the product.
AttributesSize	String	True	No	The size of the product.
AttributesSizeSystem	String	True	No	Indicates the country’s sizing system in which you are submitting your product.
AttributesSizeType	String	True	No	Additional description for the size.
AttributesTax	String	True	No	Tax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitle	String	True	No	The name of the product.
AttributesVariantNames	String	True	No	Options for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValues	String	True	No	Option values for this variant. People will see these options next to your Pin and can select the one they want. List them in the order you want them displayed.
AdAccountId	String	False	Yes	Unique identifier of an ad account.

Return to Top

CustomerLists

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountID	String	True	AdAccounts.Id	No	Associated ad account ID.
Id	String	True		No	Customer list ID.
Name	String	True		No	Customer list name.
CreatedTime	Datetime	True		No	Creation time. Unix timestamp in seconds.
UpdatedTime	Datetime	True		No	Last update time. Unix timestamp in seconds.
NumBatches	Integer	True		No	Total number of list updates.
NumRemovedUserRecords	Integer	True		No	Number of removed user records.
NumUploadedUserRecords	Integer	True		No	Number of uploaded user records.
Status	String	True		No	Customer list status. TOO_SMALL - the list has less than 100 Pinterest users.
Type	String	True		No	Always customerlist
Order	String	False		Yes	The order in which to sort the items returned: ASCENDING or DESCENDING by ID.

Return to Top

FeedProcessingResults

Name	Type	ReadOnly	References	FilterOnly	Description
Id [KEY]	String	True		No	Feed Processing Result ID.
FeedId	String	True	Feeds.Id	No	Unique identifier of a feed.
CreatedAt	Datetime	True		No	CreatedAt time.
UpdatedAt	Datetime	True		No	UpdatedAt time.
ProductCountsOriginal	Integer	True		No	The number of products in the feed file.
ProductCountsIngested	Integer	True		No	The number of products successfully ingested from the feed file.
Status	String	True		No	Status.
IngestionErrorLineLevelInternalError	Integer	True		No	We experienced a technical difficulty and were unable to ingest this some items. The next ingestion will happen in 24 hours.
IngestionErrorLargeProductCountDecrease	Integer	True		No	The product count has decreased by more than 99% compared to the last successful ingestion.
IngestionErrorAccountFlagged	Integer	True		No	We detected an issue with your account and are not currently ingesting your items.
IngestionErrorImageLevelInternalError	Integer	True		No	We experienced a technical difficulty and were unable to download some images. The next download attempt will happen in 24 hours.
IngestionErrorImageFileNotAccessible	Integer	True		No	Image files are unreadable. Please upload new files to continue.
IngestionErrorImageMalformedUrl	Integer	True		No	Image files are unreadable. Please check your link and upload new files to continue.
IngestionErrorImageFileNotFound	Integer	True		No	Image files are unreadable. Please upload new files to continue.
IngestionErrorImageInvalidFile	Integer	True		No	Image files are unreadable. Please upload new files to continue.
IngestionErrorFetchGoogleSheetNotShared	Integer	True		No	Update your Google Sheets sharing settings to 'Anyone with link' as a Viewer so that Pinterest can access your file.
IngestionInfoInStock	Integer	True		No	The number of ingested products that are in stock.
IngestionInfoOutOfStock	Integer	True		No	The number of ingested products that are in out of stock.
IngestionInfoPreorder	Integer	True		No	The number of ingested products that are in preorder.
IngestionWarningAdditionalImageLevelInternalError	Integer	True		No	We experienced a technical difficulty and were unable to download some additional images. The next download attempt will happen in 24 hours.
IngestionWarningAdditionalImageFileNotAccessible	Integer	True		No	Additional image files are unreadable. Please upload new files to continue.
IngestionWarningAdditionalImageMalformedUrl	Integer	True		No	Additional image files are unreadable. Please check your link and upload new files to continue.
IngestionWarningAdditionalImageFileNotFound	Integer	True		No	Additional image files are unreadable. Please upload new files to continue.
IngestionWarningAdditionalImageInvalidFile	Integer	True		No	Additional image files are unreadable. Please upload new files to continue.
IngestionWarningHotelPriceHeaderIsPresent	Integer	True		No	price is not a supported column. Use base_price and sale_price instead.
IngestionWarningFetchGoogleSheetPublicCanEdit	Integer	True		No	Update your Google Sheets sharing settings from 'Editor' to 'Viewer'.
ValidationErrorFetchError	Integer	True		No	Pinterest couldn't download your feed.
ValidationErrorFetchInactiveFeedError	Integer	True		No	Your feed wasn't ingested because it hasn’t changed in the previous 90 days.
ValidationErrorEncodingError	Integer	True		No	Your feed includes data with an unsupported encoding format.
ValidationErrorDelimiterError	Integer	True		No	Your feed includes data with formatting errors.
ValidationErrorRequiredColumnsMissing	Integer	True		No	Your feed is missing some required column headers.
ValidationErrorDuplicateProducts	Integer	True		No	Some products are duplicated.
ValidationErrorImageLinkInvalid	Integer	True		No	Some image links are formatted incorrectly.
ValidationErrorItemIdMissing	Integer	True		No	Some items are missing an item id in their product metadata, those items will not be published.
ValidationErrorTitleMissing	Integer	True		No	Some items are missing a title in their product metadata, those items will not be published.
ValidationErrorDescriptionMissing	Integer	True		No	Some items are missing a description in their product metadata, those items will not be published.
ValidationErrorProductLinkMissing	Integer	True		No	Some items are missing a link URL in their product metadata, those items will not be published.
ValidationErrorImageLinkMissing	Integer	True		No	Some items are missing an image link URL in their product metadata, those items will not be published.
ValidationErrorAvailabilityInvalid	Integer	True		No	Some items are missing an availability value in their product metadata, those items will not be published.
ValidationErrorProductPriceInvalid	Integer	True		No	Some items have price formatting errors in their product metadata, those items will not be published.
ValidationErrorLinkFormatInvalid	Integer	True		No	Some link values are formatted incorrectly.
ValidationErrorParseLineError	Integer	True		No	Your feed contains formatting errors for some items.
ValidationErrorAdwordsFormatInvalid	Integer	True		No	Some adwords links contain too many characters.
ValidationErrorInternalServiceError	Integer	True		No	We experienced a technical difficulty and were unable to ingest your feed. The next ingestion will happen in 24 hours.
ValidationErrorNoVerifiedDomain	Integer	True		No	Your merchant domain needs to be claimed.
ValidationErrorAdultInvalid	Integer	True		No	Some items have invalid adult values.
ValidationErrorImageLinkLengthTooLong	Integer	True		No	Some items have image_link URLs that contain too many characters, so those items will not be published.
ValidationErrorInvalidDomain	Integer	True		No	Some of your product link values don't match the verified domain associated with this account.
ValidationErrorFeedLengthTooLong	Integer	True		No	Your feed contains too many items, some items will not be published.
ValidationErrorLinkLengthTooLong	Integer	True		No	Some product links contain too many characters, those items will not be published.
ValidationErrorMalformedXml	Integer	True		No	Your feed couldn't be validated because the xml file is formatted incorrectly.
ValidationErrorPriceMissing	Integer	True		No	Some products are missing a price, those items will not be published.
ValidationErrorFeedTooSmall	Integer	True		No	Your feed couldn't be validated because the file doesn't contain the minimum number of lines required.
ValidationErrorMaxItemsPerItemGroupExceeded	Integer	True		No	Some items exceed the maximum number of items per item group, those items will not be published.
ValidationErrorItemMainImageDownloadFailure	Integer	True		No	Some items' main images can't be found.
ValidationErrorPinJoinContentUnsafe	Integer	True		No	Some items were not published because they don't meet Pinterest's Merchant Guidelines.
ValidationErrorBlocklistedImageSignature	Integer	True		No	Some items were not published because they don't meet Pinterest's Merchant Guidelines.
ValidationErrorListPriceInvalid	Integer	True		No	Some items have list price formatting errors in their product metadata, those items will not be published.
ValidationErrorPriceCannotBeDetermined	Integer	True		No	Some items were not published because price cannot be determined. The price, list price, and sale price are all different, so those items will not be published.
ValidationWarningAdLinkFormatWarning	Integer	True		No	Some items have ad links that are formatted incorrectly.
ValidationWarningAdLinkSameAsLink	Integer	True		No	Some items have ad link URLs that are duplicates of the link URLs for those items.
ValidationWarningTitleLengthTooLong	Integer	True		No	The title for some items were truncated because they contain too many characters.
ValidationWarningDescriptionLengthTooLong	Integer	True		No	The description for some items were truncated because they contain too many characters.
ValidationWarningGenderInvalid	Integer	True		No	Some items have gender values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningAgeGroupInvalid	Integer	True		No	Some items have age group values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningSizeTypeInvalid	Integer	True		No	Some items have size type values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningSizeSystemInvalid	Integer	True		No	Some items have size system values which are not one of the supported size systems.
ValidationWarningLinkFormatWarning	Integer	True		No	Some items have an invalid product link which contains invalid UTM tracking paramaters.
ValidationWarningSalesPriceInvalid	Integer	True		No	Some items have sale price values that are higher than the original price of the item.
ValidationWarningProductCategoryDepthWarning	Integer	True		No	Some items only have 1 or 2 levels of google_product_category values, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningAdwordsFormatWarning	Integer	True		No	Some items have adwords_redirect links that are formatted incorrectly.
ValidationWarningAdwordsSameAsLink	Integer	True		No	Some items have adwords_redirect URLs that are duplicates of the link URLs for those items.
ValidationWarningDuplicateHeaders	Integer	True		No	Your feed contains duplicate headers.
ValidationWarningFetchSameSignature	Integer	True		No	Ingestion completed early because there are no changes to your feed since the last successful update.
ValidationWarningAdditionalImageLinkLengthTooLong	Integer	True		No	Some items have additional_image_link URLs that contain too many characters, so those items will not be published.
ValidationWarningAdditionalImageLinkWarning	Integer	True		No	Some items have additional_image_link URLs that are formatted incorrectly and will not be published with your items.
ValidationWarningImageLinkWarning	Integer	True		No	Some items have image_link URLs that are formatted incorrectly and will not be published with those items.
ValidationWarningShippingInvalid	Integer	True		No	Some items have shipping values that are formatted incorrectly.
ValidationWarningTaxInvalid	Integer	True		No	Some items have tax values that are formatted incorrectly.
ValidationWarningShippingWeightInvalid	Integer	True		No	Some items have invalid shipping_weight values.
ValidationWarningExpirationDateInvalid	Integer	True		No	Some items have expiration_date values that are formatted incorrectly, those items will be published without an expiration date.
ValidationWarningAvailabilityDateInvalid	Integer	True		No	Some items have availability_date values that are formatted incorrectly, those items will be published without an availability date.
ValidationWarningSaleDateInvalid	Integer	True		No	Some items have sale_price_effective_date values that are formatted incorrectly, those items will be published without a sale date.
ValidationWarningWeightUnitInvalid	Integer	True		No	Some items have weight_unit values that are formatted incorrectly, those items will be published without a weight unit.
ValidationWarningIsBundleInvalid	Integer	True		No	Some items have is_bundle values that are formatted incorrectly, those items will be published without being bundled with other products.
ValidationWarningUpdatedTimeInvalid	Integer	True		No	Some items have updated_time values thate are formatted incorrectly, those items will be published without an updated time.
ValidationWarningCustomLabelLengthTooLong	Integer	True		No	Some items have custom_label values that are too long, those items will be published without that custom label.
ValidationWarningProductTypeLengthTooLong	Integer	True		No	Some items have product_type values that are too long, those items will be published without that product type.
ValidationWarningTooManyAdditionalImageLinks	Integer	True		No	Some items have additional_image_link values that exceed the limit for additional images, those items will be published without some of your images.
ValidationWarningMultipackInvalid	Integer	True		No	Some items have invalid multipack values.
ValidationWarningIndexedProductCountLargeDelta	Integer	True		No	The product count has increased or decreased significantly compared to the last successful ingestion.
ValidationWarningItemAdditionalImageDownloadFailure	Integer	True		No	Some items include additional_image_links that can't be found.
ValidationWarningOptionalProductCategoryMissing	Integer	True		No	Some items are missing a google_product_category.
ValidationWarningOptionalProductCategoryInvalid	Integer	True		No	Some items include google_product_category values that are not formatted correctly according to the GPC taxonomy.
ValidationWarningOptionalConditionMissing	Integer	True		No	Some items are missing a condition value, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningOptionalConditionInvalid	Integer	True		No	Some items include condition values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningIosDeepLinkInvalid	Integer	True		No	Some items include invalid ios_deep_link values.
ValidationWarningAndroidDeepLinkInvalid	Integer	True		No	Some items include invalid android_deep_link.
ValidationWarningUtmSourceAutoCorrected	Integer	True		No	Some items include utm_source values that are formatted incorrectly and have been automatically corrected.
ValidationWarningCountryDoesNotMapToCurrency	Integer	True		No	Some items include a currency that doesn't match the usual currency for the location where that product is sold or shipped.
ValidationWarningMinAdPriceInvalid	Integer	True		No	Some items include min_ad_price values that are formatted incorrectly.
ValidationWarningGtinInvalid	Integer	True		No	Some items include incorrectly formatted GTINs.
ValidationWarningInconsistentCurrencyValues	Integer	True		No	Some items include inconsistent currencies in price fields.
ValidationWarningSalesPriceTooLow	Integer	True		No	Some items include sales price that is much lower than the list price.
ValidationWarningShippingWidthInvalid	Integer	True		No	Some items include incorrectly formatted shipping_width.
ValidationWarningShippingHeightInvalid	Integer	True		No	Some items include incorrectly formatted shipping_height.
ValidationWarningSalesPriceTooHigh	Integer	True		No	Some items include a sales price that is higher than the list price. The sales price has been defaulted to the list price.
ValidationWarningMpnInvalid	Integer	True		No	Some items include incorrectly formatted MPNs.
AdAccountId	String	False		Yes	Unique identifier of an ad account.

Return to Top

Feeds

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	ID of the feed.
Name	String	True	No	A human-friendly name associated to a given feed.
CreatedAt	Datetime	True	No	CreatedAt time.
UpdatedAt	Datetime	True	No	UpdatedAt time.
CatalogType	String	True	No	Type of the catalog entity.
Format	String	True	No	The file format of a feed.
Location	String	True	No	The URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing.
Status	String	True	No	Status for catalogs entities. Present in catalogs_feed values. When a feed is deleted,the response will inform DELETED as status.
DefaultCurrency	String	True	No	Currency Codes from ISO 4217.
DefaultLocale	String	True	No	The locale used within a feed for product descriptions.
DefaultCountry	String	True	No	Country ID from ISO 3166-1 alpha-2.
DefaultAvailability	String	True	No	Default availability for products in a feed.
CredentialsUsername	String	True	No	The required username for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password.
CredentialsPassword	String	True	No	The required password for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password.
PreferredProcessingScheduleTime	String	True	No	A time in format HH:MM with leading 0 (zero). This field is OPTIONAL. Use this to configure the preferred time for processing a feed.
PreferredProcessingScheduleTimezone	String	True	No	The timezone considered for the processing schedule time. This field is OPTIONAL.Use this to configure the preferred time for processing a feed.
AdAccountId	String	False	Yes	Unique identifier of an ad account.
CatalogId	String	False	Yes	Filter entities for a given catalog_id. If not given, all catalogs are considered.

Return to Top

Followers

Name	Type	ReadOnly	References	FilterOnly	Description
Username [KEY]	String	True		No	Username
Type	String	True		No	Always user

Return to Top

Following

Name	Type	ReadOnly	FilterOnly	Description
Username [KEY]	String	True	No	Username
Type	String	True	No	Always user
FeedType	String	False	Yes	Specifies the type of followees to be kept when filtering them. Default - ALL
ExplicitFollowing	Boolean	False	Yes	Whether or not to include implicit user follows, which means followees with board follows.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

FollowingBoards

Name	Type	ReadOnly	FilterOnly	Description
Id [KEY]	String	True	No	ID
Name	String	True	No	Name
Description	String	True	No	Description
CreatedAt	Datetime	True	No	Date and time of board creation.
BoardPinsModifiedAt	Datetime	True	No	Date and time of last board pins modified.
CollaboratorCount	Integer	True	No	Count of collaborators on the board.
PinCount	Integer	True	No	Count of pins on the board.
FollowerCount	Integer	True	No	Board follower count.
MediaImageCoverUrl	String	True	No	Board cover image.
MediaPinThumbnailUrls	String	True	No	Board pin thumbnail urls.
OwnerUsername	String	True	No	Owner Username.
Privacy	String	True	No	Privacy setting for a board.Default - PUBLIC
ExplicitFollowing	Boolean	False	Yes	Whether or not to include implicit user follows, which means followees with board follows.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

FollowingInterests

Name	Type	ReadOnly	FilterOnly	Description
Username	String	True	No	A valid username.
Id	String	True	No	ID.
Key	String	True	No	Key.
Name	String	True	No	Name.
CanonicalUrl	String	True	No	Canonical Url.

Return to Top

LinkedBusinesses

Name	Type	ReadOnly	FilterOnly	Description
Username [KEY]	String	True	No	A valid username.
ImageSmallUrl	String	True	No	Image Small Url.
ImageMediumUrl	String	True	No	Image Medium Url.
ImageLargeUrl	String	True	No	Image Large Url.
ImageXLargeUrl	String	True	No	Image XLarge Url.

Return to Top

Pins

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

Return to Top

ProductGroupAnalytics

Name	Type	ReadOnly	References	FilterOnly	Description
AdAccountId	String	True	AdAccounts.Id	No	Unique identifier of an ad account.
ProductGroupId	String	True		No	Product group Ids .
TargetingType	String	True		No	Targeting type.
TargetingValues	String	True		No	Targeting type value.
Date	Date	True		No	Date the analytics row covers.
SpendInDollar	Decimal	True		No	Total spend in dollars.
AdvertiserId	Double	True		No	Id of the advertiser.
AdGroupEntityStatus	Double	True		No	Id of the advertiser.
AdId	Double	True		No	Id of the advertiser.
CampaignId	String	True	Campaigns.Id	No	Id of the Campaign.
CampaignDailySpendCap	String	True		No	Campaign daily spend cap.
CampaignEntityStatus	String	True		No	Campaign entity status.
CampaignLifetimeSpendCap	Integer	True		No	Campaign Lifetime Spend Cap.
Ctr	Double	True		No	Ctr.
Ctr2	Double	True		No	Ctr2.
CheckoutRoas	Double	True		No	Checkout roas.
Clickthrough1	Integer	True		No	Clickthrough1.
Clickthrough2	Integer	True		No	Clickthrough2.
Clickthrough1Gross	Integer	True		No	Clickthrough1 Gross.
CpcInMicroDollar	Decimal	True		No	Cpc In MicroDollar.
CpmInMicroDollar	Decimal	True		No	Cpm In MicroDollar.
Ectr	Decimal	True		No	Ectr.
EcpeInDollar	Decimal	True		No	Ecpe in Dollars.
EngagementRate	Double	True		No	The engagement rate.
EengagementRate	Double	True		No	E Engagement rate.
EcpvInDollar	Decimal	True		No	Ecpv in dollars.
EcpcvInDollar	Decimal	True		No	E Cpcv in Dollars.
EcpcvP95InDollar	Decimal	True		No	E Cpcv 95 percent in Dollars.
EcpcInMicroDollar	Decimal	True		No	Ecpc In MicroDollar.
EcpmInMicroDollar	Decimal	True		No	Ecpm In MicroDollar.
Engagement1	Integer	True		No	Engagement1.
Engagement2	Integer	True		No	Engagement2.
Impression1	Integer	True		No	Impression1.
Impression1Gross	Integer	True		No	Impression1 Gross.
Impression2	Integer	True		No	Impression2.
IdeaPinProductTagVisit1	Integer	True		No	Idea Pin Product Tag Visit1.
IdeaPinProductTagVisit2	Integer	True		No	Idea Pin Product Tag Visit2.
InAppCheckoutCostPerAction	Double	True		No	In App Checkout Cost Per Action.
OutboundClick1	Integer	True		No	Outboundclick1.
OutboundClick2	Integer	True		No	Outboundclick2.
PinId	String	True	Pins.Id	No	Id of the Pins.
PageVisitCostPerAction	Double	True		No	Page visit cost per action.
PageVisitRoas	Double	True		No	Page visit roas.
PaidImpression	Integer	True		No	PaidImpression.
Repin1	Integer	True		No	Repin1.
Repin2	Integer	True		No	Repin2.
RepinRate	Double	True		No	The repin rate.
TotalClickthrough	Integer	True		No	Total Clickthrough.
TotalEngagementSignup	Integer	True		No	Total Engagement Signup.
TotalEngagementCheckout	Integer	True		No	Total Engagement Checkout.
TotalClickSignup	Integer	True		No	Total Click Signup.
TotalClickCheckout	Integer	True		No	Total Click Checkout.
TotalViewSignup	Integer	True		No	Total View Signup.
TotalViewCheckout	Integer	True		No	Total View Checkout.
TotalConversions	Integer	True		No	Total Conversions.
TotalEngagementSignupValueInMicroDollar	Decimal	True		No	Total Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollar	Decimal	True		No	Total Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollar	Decimal	True		No	Total Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollar	Decimal	True		No	Total View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollar	Decimal	True		No	Total View Checkout Value In Micro Dollar.
TotalPageVisit	Integer	True		No	Total Page Visit.
TotalSignup	Integer	True		No	Total Signup.
TotalCheckout	Integer	True		No	Total Checkout.
TotalSignupValueInMicroDollar	Decimal	True		No	Total Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollar	Decimal	True		No	Total Checkout Value In Micro Dollar.
TotalVideo3secViews	Integer	True		No	Total Video 3 second Views.
TotalVideoP100Complete	Integer	True		No	Total Video 100 percent Complete.
TotalVideoP0Combined	Integer	True		No	Total Video 0 percent Combined.
TotalVideoP25Combined	Integer	True		No	Total Video 25 percent Combined.
TotalVideoP50Combined	Integer	True		No	Total Video 50 percent Combined.
TotalVideoP75Combined	Integer	True		No	Total Video 75 percent Combined.
TotalVideoP95Combined	Integer	True		No	Total Video 95 percent Combined.
TotalVideoMrcViews	Integer	True		No	Total Video Mrc Views.
TotalVideoAvgWatchtimeInSecond	Integer	True		No	Total Video Avg Watchtime In Seconds.
TotalRepinRate	Double	True		No	Total Repin Rate.
TotalWebCheckout	Integer	True		No	Total Web Checkout.
TotalWebCheckoutValueInMicroDollar	Decimal	True		No	Total Web Checkout Value In Micro Dollar.
TotalWebClickCheckout	Integer	True		No	Total Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollar	Decimal	True		No	Total Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckout	Integer	True		No	Total Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollar	Decimal	True		No	Total Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckout	Integer	True		No	Total Web View Checkout.
TotalWebViewCheckoutValueInMicroDollar	Decimal	True		No	Total Web View Checkout Value In Micro Dollar.
Video3secViews2	Integer	True		No	Video 3 second Views.
VideoLength	Integer	True		No	VideoLength.
VideoMrcViews2	Integer	True		No	Video 2 second Views.
VideoP0Combined2	Integer	True		No	Video 0 percent Combined Views.
VideoP100Complete2	Integer	True		No	Video 100 percent Complete Views.
VideoP25Combined2	Integer	True		No	Video 25 percent Complete Views.
VideoP50Combined2	Integer	True		No	Video 50 percent Complete Views.
VideoP75Combined2	Integer	True		No	Video 75 percent Complete Views.
VideoP95Combined2	Integer	True		No	Video 95 percent Complete Views.
WebCheckoutCostPerAction	Double	True		No	Web checkout cost per action.
WebCheckoutRoas	Double	True		No	Web checkout roas.
WebSessions1	Integer	True		No	WebSessions1.
WebSessions2	Integer	True		No	WebSessions2.
StartDate	Date	True		No	Metric report start date.
EndDate	Date	True		No	Metric report end date.
Granularity	String	True		No	Granularity.
AttributionTypes	String	False		Yes	List of types of attribution for the conversion report.
ClickWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a pin click action.
EngagementWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for an engagement action.
ViewWindowDays	Integer	False		Yes	Number of days to use as the conversion attribution window for a view action.
ConversionReportTime	Integer	False		Yes	The date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

TargetingTypeAgeBucket

Name	Type	ReadOnly	References	FilterOnly	Description
AgeBucketKey	String	True		No	It contains the key of the age bucket.
AgeBucketValue	String	True		No	It contains the value of the age bucket.

Return to Top

TargetingTypeAppType

Name	Type	ReadOnly	References	FilterOnly	Description
AppKey	String	True		No	It contains the key of the apptype.
AppValue	String	True		No	It contains the value of the apptype.

Return to Top

TargetingTypeAudienceExclude

Name	Type	ReadOnly	References	FilterOnly	Description
AudienceExcludeKey	String	True		No	It contains the key of the Audience Exclude metric.
AudienceExcludeValue	String	True		No	It contains the value of the Audience Exclude metric.

Return to Top

TargetingTypeAudienceInclude

Name	Type	ReadOnly	References	FilterOnly	Description
AudienceIncludeKey	String	True		No	It contains the key of the Audience Include metric.
AudienceIncludeValue	String	True		No	It contains the value of the Audience Include metric.

Return to Top

TargetingTypeGender

Name	Type	ReadOnly	References	FilterOnly	Description
GenderKey	String	True		No	It contains the key of the gender.
GenderValue	String	True		No	It contains the value of the gender.

Return to Top

TargetingTypeGeo

Name	Type	ReadOnly	References	FilterOnly	Description
GeoKey	String	True		No	It contains the key of the Geo.
GeoValue	String	True		No	It contains the value of the Geo.

Return to Top

TargetingTypeInterests

Name	Type	ReadOnly	FilterOnly	Description
InterestId	String	True	No	It contains the id of the interest.
InterestLevel	String	True	No	It contains the level of the interest.
InterestName	String	True	No	It contains the name of the interest.
InterestAggregate	String	True	No	It contains the data inside the particular level of the interest.

Return to Top

TargetingTypeKeyword

Name	Type	ReadOnly	References	FilterOnly	Description
KeywordKey	String	True		No	It contains the key of the keyword.
KeywordValue	String	True		No	It contains the value of the keyword.

Return to Top

TargetingtypeLocale

Name	Type	ReadOnly	References	FilterOnly	Description
LocaleKey	String	True		No	It contains the key of the locale
LocaleValue	String	True		No	It contains the value of the locale

Return to Top

TargetingTypeLocations

Name	Type	ReadOnly	References	FilterOnly	Description
LocationKey	String	True		No	It contains the key of the Location
LocationValue	String	True		No	It contains the value of the Location

Return to Top

UserAccount

Name	Type	ReadOnly	FilterOnly	Description
AccountType	String	True	No	Type of account.
ProfileImage	String	True	No	Profile Image.
Username	String	True	No	Username.
WebsiteURL	String	True	No	Website URL.
BoardCount	Integer	True	No	Board count.
PinCount	Integer	True	No	Pin count.
FollowerCount	Integer	True	No	Follower count.
FollowingCount	Integer	True	No	Following count.
AdAccountID	String	False	Yes	Specify an ad_account_id to use the owner of that ad_account as the operation user_account.

Return to Top

UserAccountDailyMetrics

Name	Type	ReadOnly	FilterOnly	Description
OutboundClick	Integer	True	No	Total outbound click.
OutboundClickRate	Decimal	True	No	Outbound Click Rate.
Engagement	Integer	True	No	Total engagements.
EngagementRate	Decimal	True	No	Engagement Rate.
PinClick	Integer	True	No	Total pin clicks.
PinClickRate	Decimal	True	No	Pin Click Rate.
Impression	Integer	True	No	Total impressions.
Save	Integer	True	No	Total saves.
SaveRate	Decimal	True	No	Save Rate.
DataStatus	String	True	No	Metrics Availablity.
Date	Date	True	No	Metrics Date.
StartDate	Date	True	No	Metric report start date.
EndDate	Date	True	No	Metric report end date.
FromClaimedContent	String	False	Yes	Filter on Pins that match your claimed domain.
PinFormat	String	False	Yes	Pin formats to get data for, default is all.
AppTypes	String	False	Yes	Apps or devices to get data for, default is all.
MetricTypes	String	False	Yes	Metric types to get data for, default is all.
SplitField	String	False	Yes	How to split the data into groups. Not including this param means data won't be split.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

UserAccountSummaryMetrics

Name	Type	ReadOnly	FilterOnly	Description
OutboundClick	Integer	True	No	Total outbound click.
OutboundClickRate	Decimal	True	No	Outbound Click Rate.
Engagement	Integer	True	No	Total engagements.
EngagementRate	Decimal	True	No	Engagement Rate.
PinClick	Integer	True	No	Total pin clicks.
PinClickRate	Decimal	True	No	Pin Click Rate.
Impression	Integer	True	No	Total impressions.
Save	Integer	True	No	Total saves.
SaveRate	Decimal	True	No	Save Rate.
StartDate	Date	True	No	Metric report start date.
EndDate	Date	True	No	Metric report end date.
FromClaimedContent	String	False	Yes	Filter on Pins that match your claimed domain.
PinFormat	String	False	Yes	Pin formats to get data for, default is all.
AppTypes	String	False	Yes	Apps or devices to get data for, default is all.
MetricTypes	String	False	Yes	Metric types to get data for, default is all.
SplitField	String	False	Yes	How to split the data into groups. Not including this param means data won't be split.
AdAccountID	String	False	Yes	Unique identifier of an ad account.

Return to Top

UserAccountTopVideoPinAnalytics

Name	Type	ReadOnly	FilterOnly	Description
StartDate	Date	True	No	Metric report start date.
EndDate	Date	True	No	Metric report end date.
SortBy	String	False	No	Specify sorting order for metrics.
Impression	Integer	True	No	Impression.
Save	Integer	True	No	Save.
VideoMrcView	Integer	True	No	Video second Views.
VideoAvgWatchTime	Integer	True	No	Video second Views.
VideoV50WatchTime	Integer	True	No	Video 50 Seond Views.
Quartile95PercentView	Integer	True	No	Video 95 percent Views.
Video10SView	Integer	True	No	Video 10 second Views.
VideoStart	Integer	True	No	VIDEO_START.
OutboundClick	Integer	True	No	Outboundclick.
CreatedInLastNDays	Integer	False	Yes	Get metrics for pins created in the last
NumOfPins	Integer	False	Yes	Number of pins to include, default is 10. Max is 50.
MetricTypes	String	False	Yes	Metric types to get data for, default is all.
AppType	String	False	Yes	Apps or devices to get data for, default is all.
PinFormat	String	False	Yes	Pin formats to get data for, default is all.
FromClaimedContent	String	False	Yes	Filter on Pins that match your claimed domain.

Return to Top

UserTopPinAnalytics

Name	Type	ReadOnly	FilterOnly	Description
StartDate	Date	True	No	Metric report start date.
EndDate	Date	True	No	Metric report end date.
SortBy	String	True	No	Specify sorting order for metrics.
Engagement	Integer	True	No	Engagement.
EngagementRate	Double	True	No	The engagement rate.
Impression	Integer	True	No	Impression.
OutboundClick	Integer	True	No	Outboundclick.
OutboundClickRate	Integer	True	No	OUTBOUNDCLICKRATE.
PinClick	Integer	True	No	PINCLICK.
PinClickRate	Integer	True	No	PINCLICKRate.
Save	Integer	True	No	Save.
SaveRate	Integer	True	No	SAVE RATE.
CreatedInLastNDays	Integer	False	Yes	Get metrics for pins created in the last
NumOfPins	Integer	False	Yes	Number of pins to include, default is 10. Max is 50.
MetricTypes	String	False	Yes	Metric types to get data for, default is all.
AppType	String	False	Yes	Apps or devices to get data for, default is all.
PinFormat	String	False	Yes	Pin formats to get data for, default is all.
FromClaimedContent	String	False	Yes	Filter on Pins that match your claimed domain.

Return to Top

UserVerificationCodeForWebsiteClaim

Name	Type	ReadOnly	FilterOnly	Description
VerificationCode	String	True	No	Code to check against the user claiming the website.
DnsTxtRecord	String	True	No	DNS TXT record to check against for the website to be claimed.
Metatag	String	True	No	Metatag the verification process searchs for the website to be claimed.
Filename	String	True	No	File expected to find on the website being claimed.
FileContent	String	True	No	A full html file to upload to the website in order for it to be claimed.

Return to Top

UserWebsites

Name	Type	ReadOnly	FilterOnly	Description
Website	String	True	No	Website with path or domain only
Status	String	True	No	Status of the verification process.
VerifiedAt	Datetime	True	No	UTC timestamp when the verification happened - sometimes missing.

Return to Top