Pinterest Connector Objects

NameDescription
AdAccountAnalyticsGet analytics for the specified AdAccountId
AdAccountAnalyticsReportGet the ad account analytics report
AdAccountsGet a list of the ad_accounts that the User has access to.
AdAccountTargetingAnalyticsGet targeting analytics for an ad account.
AdAnalyticsGet analytics for the ads in the specified AdAccountId
AdCampaignAnalyticsGet analytics for the specified campaigns in the specified AdAccountId
AdGroupAnalyticsGet analytics for the ad groups in the specified AdAccountId
AdGroupsGet a list of the ad_accounts that the User has access to.
AdGroupTargetingAnalyticsGet targeting analytics for one or more ad groups.
AdsGet a list of the ad_accounts that the User has access to.
AdsTargetingAnalyticsGet targeting analytics for one or more ads.
AudienceInsightsGet Audience Insights for an ad account.
AudienceInsightsScopeAndTypeGet the scope and type of available audiences, which along with a date, is an audience that has recently had an interaction on pins.
AudiencesGet list of audiences for the ad account.
BoardsGet a list of the boards owned by the User
BoardSectionsGet a list of the boards owned by the User
CampaignsGet account information for the operation user_account
CampaignTargetingAnalyticsGet targeting analytics for one or more campaign.
CatalogHotelReportGet the hotel catalog report
CatalogProcessingResultItemIssuesFetch feeds owned by the operation user_account
CatalogRetailReportGet the retail catalog report
CatalogsFetch catalogs owned by the operation user_account
CatalogTypeCreativeAssetsItemsGet the items of the catalog of type CREATIVE_ASSETS owned by the operation user_account
CatalogTypeHotelItemsGet the items of the catalog of type HOTEL owned by the operation user_account
CatalogTypeRetailItemsGet the items of the catalog of type RETAIL owned by the operation user_account
CustomerListsGet a set of customer lists including id and name based on the filters provided. Customer lists are a type of audience.
FeedProcessingResultsFetch feeds owned by the operation user_account
FeedsFetch feeds owned by the operation user_account
FollowersGet a list of your followers.
FollowingGet a list of your followers.
FollowingBoardsGet a list of the boards a user follows.
FollowingInterestsGet a list of a user's following interests in one place.
LinkedBusinessesGet a list of your linked business accounts.
PinsGet a Pin owned by the owned by the User or on a group board that has been shared with this account
ProductGroupAnalyticsGet targeting analytics for one or more campaign.
TargetingTypeAgeBucketGet a list of the age bucket which are available inside the targets.
TargetingTypeAppTypeGet a list of the app type which are available inside the targets.
TargetingTypeAudienceExcludeGet a list of the interest which are available inside the targets.
TargetingTypeAudienceIncludeGet a list of the interest which are available inside the targets.
TargetingTypeGenderGet a list of the gender which are available inside the targets.
TargetingTypeGeoGet a list of the geo which are available inside the targets.
TargetingTypeInterestsGet a list of the interest which are available inside the targets.
TargetingTypeKeywordGet a list of the interest which are available inside the targets.
TargetingtypeLocaleGet a list of the locale which are available inside the targets.
TargetingTypeLocationsGet a list of the location which are available inside the targets.
UserAccountGet account information for the operation User Account
UserAccountDailyMetricsGet Daily Metric of User Account
UserAccountSummaryMetricsGet Summary Metric of User Account
UserAccountTopVideoPinAnalyticsGet analytics data about a user's top pins.
UserTopPinAnalyticsGet analytics data about a user's top pins.
UserVerificationCodeForWebsiteClaimGet verification code for user to install on the website to claim it.
UserWebsitesGet user websites, claimed or not.
NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoId of the ad account
DateDateTrueNoCurrent metrics date. Only returned when granularity is a time-based value.
CampaignEntityStatusStringTrueNoStatus of the campaign.
AdGroupEntityStatusStringTrueNoStatus of the ad group.
SpendInDollarDoubleTrueNoTotal spend in dollars.
EcpcInDollarDoubleTrueNoEcpc in dollars.
CtrDoubleTrueNoCtr.
EctrDoubleTrueNoEctr.
EcpeInDollarDoubleTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
RepinRateDoubleTrueNoThe repin rate.
Ctr2DoubleTrueNoCtr2
CpmInDollarDoubleTrueNoCpm in Dollars.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
CheckoutRoasDoubleTrueNoCheckout roas.
Video3secViews2IntegerTrueNoVideos with at least 3 seconds of viewing.
VideoP100Complete2IntegerTrueNoVideos 100 percent complete
VideoP0Combined2IntegerTrueNoVideos 0 percent combined viewed.
VideoP25Combined2IntegerTrueNoVideos 25 percent combined viewed.
VideoP50Combined2IntegerTrueNoVideo 50 percent combined viewed.
VideoP75Combined2IntegerTrueNoVideo 75 percent combined viewed.
VideoP95Combined2IntegerTrueNoVideo 95 percent combined viewed.
VideoMrcViews2IntegerTrueNoVideo Mrc Views.
EcpvInDollarDoubleTrueNoEcpv in dollars.
EcpcvInDollarDoubleTrueNoE Cpcv in Dollars
EcpcvP95InDollarDoubleTrueNoE Cpcv 95 percent in Dollars.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalImpressionFrequencyDoubleTrueNoTotal Impression Frequency.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDoubleTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDoubleTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDoubleTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDoubleTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDoubleTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDoubleTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDoubleTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDoubleTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDoubleTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDoubleTrueNoTotal Web View Checkout Value In Micro Dollar.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
AdIdStringTrueAds.IdNoId of the Ad.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeStringFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoId of the ad account.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity
LevelStringTrueNoLevel of the report.
AdGroupEntityStatusStringTrueNo
AdGroupIdStringTrueNo
AdGroupNameStringTrueNo
AdGroupStatusStringTrueNo
AdIdStringTrueNo
AdNameStringTrueNo
AdStatusStringTrueNo
AdvertiserIdStringTrueNo
APPINSTALLCOSTPERACTIONIntegerTrueNo
CAMPAIGNDAILYSPENDCAPIntegerTrueNo
CAMPAIGNENTITYSTATUSStringTrueNo
CAMPAIGNIDStringTrueNo
CAMPAIGNLIFETIMESPENDCAPIntegerTrueNo
CAMPAIGNMANAGEDSTATUSStringTrueNo
CAMPAIGNNAMEStringTrueNo
CAMPAIGNSTATUSStringTrueNo
CHECKOUTROASStringTrueNo
CLICKTHROUGH1IntegerTrueNo
CLICKTHROUGH1GROSSIntegerTrueNo
CLICKTHROUGH2IntegerTrueNo
CPCINMICRODOLLARIntegerTrueNo
CPCVINMICRODOLLARIntegerTrueNo
CPCVP95INMICRODOLLARIntegerTrueNo
CPMINDOLLARIntegerTrueNo
CPMINMICRODOLLARIntegerTrueNo
CPVINMICRODOLLARIntegerTrueNo
CTRIntegerTrueNo
CTR2IntegerTrueNo
ECPCINDOLLARIntegerTrueNo
ECPCINMICRODOLLARIntegerTrueNo
ECPCVINDOLLARIntegerTrueNo
ECPCVP95INDOLLARIntegerTrueNo
ECPEINDOLLARIntegerTrueNo
ECPMINMICRODOLLARIntegerTrueNo
ECPVINDOLLARIntegerTrueNo
ECTRIntegerTrueNo
EENGAGEMENTRATEIntegerTrueNo
ENGAGEMENT1IntegerTrueNo
ENGAGEMENT2IntegerTrueNo
ENGAGEMENTRATEIntegerTrueNo
IDEAPINPRODUCTTAGVISIT1StringTrueNo
IDEAPINPRODUCTTAGVISIT2StringTrueNo
IMPRESSION1IntegerTrueNo
IMPRESSION1GROSSIntegerTrueNo
IMPRESSION2IntegerTrueNo
INAPPADDTOCARTCOSTPERACTIONIntegerTrueNo
INAPPADDTOCARTROASStringTrueNo
INAPPAPPINSTALLCOSTPERACTIONIntegerTrueNo
INAPPAPPINSTALLROASStringTrueNo
INAPPCHECKOUTCOSTPERACTIONIntegerTrueNo
INAPPCHECKOUTROASStringTrueNo
INAPPSEARCHCOSTPERACTIONIntegerTrueNo
INAPPSEARCHROASStringTrueNo
INAPPSIGNUPCOSTPERACTIONIntegerTrueNo
INAPPSIGNUPROASStringTrueNo
INAPPUNKNOWNCOSTPERACTIONIntegerTrueNo
INAPPUNKNOWNROASStringTrueNo
OFFLINECHECKOUTCOSTPERACTIONIntegerTrueNo
OFFLINECHECKOUTROASStringTrueNo
OFFLINECUSTOMCOSTPERACTIONIntegerTrueNo
OFFLINECUSTOMROASStringTrueNo
OFFLINELEADCOSTPERACTIONIntegerTrueNo
OFFLINELEADROASStringTrueNo
OFFLINESIGNUPCOSTPERACTIONIntegerTrueNo
OFFLINESIGNUPROASStringTrueNo
OFFLINEUNKNOWNCOSTPERACTIONIntegerTrueNo
OFFLINEUNKNOWNROASStringTrueNo
ONSITECHECKOUTS1IntegerTrueNo
OUTBOUNDCLICK1IntegerTrueNo
OUTBOUNDCLICK2IntegerTrueNo
PAGEVISITCOSTPERACTIONIntegerTrueNo
PAGEVISITROASStringTrueNo
PAIDIMPRESSIONIntegerTrueNo
PINIDStringTrueNo
PINPROMOTIONIDStringTrueNo
PINPROMOTIONNAMEStringTrueNo
PINPROMOTIONSTATUSStringTrueNo
PRODUCTGROUPIDStringTrueNo
REPIN1IntegerTrueNo
REPIN2IntegerTrueNo
REPINRATEStringTrueNo
SPENDINDOLLARIntegerTrueNo
SPENDINMICRODOLLARIntegerTrueNo
TOTALADDTOCARTDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALADDTOCARTDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALADDTOCARTDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALADDTOCARTMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALADDTOCARTMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALADDTOCARTMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALADDTOCARTTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALADDTOCARTTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALADDTOCARTTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALAPPINSTALLIntegerTrueNo
TOTALAPPINSTALLDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALAPPINSTALLDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALAPPINSTALLDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALAPPINSTALLMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALAPPINSTALLMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALAPPINSTALLMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALAPPINSTALLTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALAPPINSTALLTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALAPPINSTALLTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALCHECKOUTIntegerTrueNo
TOTALCHECKOUTDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCHECKOUTDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCHECKOUTDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALCHECKOUTMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCHECKOUTMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCHECKOUTMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALCHECKOUTQUANTITYIntegerTrueNo
TOTALCHECKOUTTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCHECKOUTTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCHECKOUTTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKADDTOCARTIntegerTrueNo
TOTALCLICKADDTOCARTQUANTITYIntegerTrueNo
TOTALCLICKADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKAPPINSTALLIntegerTrueNo
TOTALCLICKAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKCHECKOUTIntegerTrueNo
TOTALCLICKCHECKOUTQUANTITYIntegerTrueNo
TOTALCLICKCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKCUSTOMIntegerTrueNo
TOTALCLICKCUSTOMQUANTITYIntegerTrueNo
TOTALCLICKCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKLEADIntegerTrueNo
TOTALCLICKLEADQUANTITYIntegerTrueNo
TOTALCLICKLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKPAGEVISITIntegerTrueNo
TOTALCLICKPAGEVISITQUANTITYIntegerTrueNo
TOTALCLICKPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKSEARCHIntegerTrueNo
TOTALCLICKSEARCHQUANTITYIntegerTrueNo
TOTALCLICKSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKSIGNUPIntegerTrueNo
TOTALCLICKSIGNUPQUANTITYIntegerTrueNo
TOTALCLICKSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKUNKNOWNIntegerTrueNo
TOTALCLICKUNKNOWNQUANTITYIntegerTrueNo
TOTALCLICKUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKVIEWCATEGORYStringTrueNo
TOTALCLICKVIEWCATEGORYQUANTITYIntegerTrueNo
TOTALCLICKVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKWATCHVIDEOIntegerTrueNo
TOTALCLICKWATCHVIDEOQUANTITYIntegerTrueNo
TOTALCLICKWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALCLICKTHROUGHIntegerTrueNo
TOTALCONVERSIONSIntegerTrueNo
TOTALCONVERSIONSQUANTITYIntegerTrueNo
TOTALCONVERSIONSVALUEINMICRODOLLARIntegerTrueNo
TOTALCUSTOMIntegerTrueNo
TOTALCUSTOMDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCUSTOMDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCUSTOMDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALCUSTOMMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCUSTOMMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCUSTOMMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALCUSTOMTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALCUSTOMTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALCUSTOMTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALENGAGEMENTIntegerTrueNo
TOTALENGAGEMENTADDTOCARTIntegerTrueNo
TOTALENGAGEMENTADDTOCARTQUANTITYIntegerTrueNo
TOTALENGAGEMENTADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTAPPINSTALLIntegerTrueNo
TOTALENGAGEMENTAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTCHECKOUTIntegerTrueNo
TOTALENGAGEMENTCHECKOUTQUANTITYIntegerTrueNo
TOTALENGAGEMENTCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTCUSTOMIntegerTrueNo
TOTALENGAGEMENTCUSTOMQUANTITYIntegerTrueNo
TOTALENGAGEMENTCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTLEADIntegerTrueNo
TOTALENGAGEMENTLEADQUANTITYIntegerTrueNo
TOTALENGAGEMENTLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTPAGEVISITIntegerTrueNo
TOTALENGAGEMENTPAGEVISITQUANTITYIntegerTrueNo
TOTALENGAGEMENTPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTSEARCHIntegerTrueNo
TOTALENGAGEMENTSEARCHQUANTITYIntegerTrueNo
TOTALENGAGEMENTSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTSIGNUPIntegerTrueNo
TOTALENGAGEMENTSIGNUPQUANTITYIntegerTrueNo
TOTALENGAGEMENTSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTUNKNOWNIntegerTrueNo
TOTALENGAGEMENTUNKNOWNQUANTITYIntegerTrueNo
TOTALENGAGEMENTUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTVIEWCATEGORYStringTrueNo
TOTALENGAGEMENTVIEWCATEGORYQUANTITYIntegerTrueNo
TOTALENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALENGAGEMENTWATCHVIDEOIntegerTrueNo
TOTALENGAGEMENTWATCHVIDEOQUANTITYIntegerTrueNo
TOTALENGAGEMENTWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALIDEAPINPRODUCTTAGVISITIntegerTrueNo
TOTALIMPRESSIONFREQUENCYIntegerTrueNo
TOTALIMPRESSIONUSERIntegerTrueNo
TOTALINAPPADDTOCARTStringTrueNo
TOTALINAPPADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPAPPINSTALLIntegerTrueNo
TOTALINAPPAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCHECKOUTIntegerTrueNo
TOTALINAPPCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKADDTOCARTIntegerTrueNo
TOTALINAPPCLICKADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKAPPINSTALLIntegerTrueNo
TOTALINAPPCLICKAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKCHECKOUTIntegerTrueNo
TOTALINAPPCLICKCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKSEARCHIntegerTrueNo
TOTALINAPPCLICKSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKSIGNUPIntegerTrueNo
TOTALINAPPCLICKSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPCLICKUNKNOWNIntegerTrueNo
TOTALINAPPCLICKUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTADDTOCARTIntegerTrueNo
TOTALINAPPENGAGEMENTADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTAPPINSTALLIntegerTrueNo
TOTALINAPPENGAGEMENTAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTCHECKOUTIntegerTrueNo
TOTALINAPPENGAGEMENTCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTSEARCHIntegerTrueNo
TOTALINAPPENGAGEMENTSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTSIGNUPIntegerTrueNo
TOTALINAPPENGAGEMENTSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPENGAGEMENTUNKNOWNIntegerTrueNo
TOTALINAPPENGAGEMENTUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPSEARCHIntegerTrueNo
TOTALINAPPSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPSIGNUPIntegerTrueNo
TOTALINAPPSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPUNKNOWNIntegerTrueNo
TOTALINAPPUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWADDTOCARTIntegerTrueNo
TOTALINAPPVIEWADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWAPPINSTALLIntegerTrueNo
TOTALINAPPVIEWAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWCHECKOUTIntegerTrueNo
TOTALINAPPVIEWCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWSEARCHIntegerTrueNo
TOTALINAPPVIEWSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWSIGNUPIntegerTrueNo
TOTALINAPPVIEWSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALINAPPVIEWUNKNOWNStringTrueNo
TOTALINAPPVIEWUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALLEADIntegerTrueNo
TOTALLEADDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALLEADDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALLEADDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALLEADMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALLEADMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALLEADMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALLEADTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALLEADTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALLEADTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALOFFLINECHECKOUTIntegerTrueNo
TOTALOFFLINECHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECLICKCHECKOUTIntegerTrueNo
TOTALOFFLINECLICKCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECLICKCUSTOMIntegerTrueNo
TOTALOFFLINECLICKCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECLICKLEADIntegerTrueNo
TOTALOFFLINECLICKLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECLICKSIGNUPIntegerTrueNo
TOTALOFFLINECLICKSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECLICKUNKNOWNIntegerTrueNo
TOTALOFFLINECLICKUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINECUSTOMIntegerTrueNo
TOTALOFFLINECUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEENGAGEMENTCHECKOUTIntegerTrueNo
TOTALOFFLINEENGAGEMENTCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEENGAGEMENTCUSTOMIntegerTrueNo
TOTALOFFLINEENGAGEMENTCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEENGAGEMENTLEADIntegerTrueNo
TOTALOFFLINEENGAGEMENTLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEENGAGEMENTSIGNUPIntegerTrueNo
TOTALOFFLINEENGAGEMENTSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEENGAGEMENTUNKNOWNIntegerTrueNo
TOTALOFFLINEENGAGEMENTUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINELEADIntegerTrueNo
TOTALOFFLINELEADVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINESIGNUPIntegerTrueNo
TOTALOFFLINESIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEUNKNOWNIntegerTrueNo
TOTALOFFLINEUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEVIEWCHECKOUTIntegerTrueNo
TOTALOFFLINEVIEWCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEVIEWCUSTOMIntegerTrueNo
TOTALOFFLINEVIEWCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEVIEWLEADIntegerTrueNo
TOTALOFFLINEVIEWLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEVIEWSIGNUPIntegerTrueNo
TOTALOFFLINEVIEWSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALOFFLINEVIEWUNKNOWNIntegerTrueNo
TOTALOFFLINEVIEWUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALPAGEVISITIntegerTrueNo
TOTALPAGEVISITDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALPAGEVISITDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALPAGEVISITDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALPAGEVISITMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALPAGEVISITMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALPAGEVISITMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALPAGEVISITTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALPAGEVISITTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALPAGEVISITTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALREPINRATEIntegerTrueNo
TOTALSEARCHDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSEARCHDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSEARCHDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSEARCHMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSEARCHMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSEARCHMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSEARCHTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSEARCHTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSEARCHTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSIGNUPIntegerTrueNo
TOTALSIGNUPDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSIGNUPDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSIGNUPDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSIGNUPMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSIGNUPMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSIGNUPMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSIGNUPTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALSIGNUPTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALSIGNUPTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALUNKNOWNDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALUNKNOWNDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALUNKNOWNDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALUNKNOWNMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALUNKNOWNMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALUNKNOWNMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALUNKNOWNTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALUNKNOWNTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALUNKNOWNTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALVIDEO3SECVIEWSIntegerTrueNo
TOTALVIDEOAVGWATCHTIMEINSECONDStringTrueNo
TOTALVIDEOMRCVIEWSIntegerTrueNo
TOTALVIDEOP0COMBINEDStringTrueNo
TOTALVIDEOP100COMPLETEStringTrueNo
TOTALVIDEOP25COMBINEDStringTrueNo
TOTALVIDEOP50COMBINEDStringTrueNo
TOTALVIDEOP75COMBINEDStringTrueNo
TOTALVIDEOP95COMBINEDIntegerTrueNo
TOTALVIEWADDTOCARTIntegerTrueNo
TOTALVIEWADDTOCARTQUANTITYIntegerTrueNo
TOTALVIEWADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWAPPINSTALLIntegerTrueNo
TOTALVIEWAPPINSTALLVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWCATEGORYDESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYDESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYDESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALVIEWCATEGORYTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALVIEWCHECKOUTIntegerTrueNo
TOTALVIEWCHECKOUTQUANTITYIntegerTrueNo
TOTALVIEWCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWCUSTOMIntegerTrueNo
TOTALVIEWCUSTOMQUANTITYIntegerTrueNo
TOTALVIEWCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWLEADIntegerTrueNo
TOTALVIEWLEADQUANTITYIntegerTrueNo
TOTALVIEWLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWPAGEVISITIntegerTrueNo
TOTALVIEWPAGEVISITQUANTITYIntegerTrueNo
TOTALVIEWPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWSEARCHIntegerTrueNo
TOTALVIEWSEARCHQUANTITYIntegerTrueNo
TOTALVIEWSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWSIGNUPIntegerTrueNo
TOTALVIEWSIGNUPQUANTITYIntegerTrueNo
TOTALVIEWSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWUNKNOWNIntegerTrueNo
TOTALVIEWUNKNOWNQUANTITYIntegerTrueNo
TOTALVIEWUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWVIEWCATEGORYStringTrueNo
TOTALVIEWVIEWCATEGORYQUANTITYIntegerTrueNo
TOTALVIEWVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALVIEWWATCHVIDEOIntegerTrueNo
TOTALVIEWWATCHVIDEOQUANTITYIntegerTrueNo
TOTALVIEWWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALWATCHVIDEODESKTOPACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALWATCHVIDEODESKTOPACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALWATCHVIDEODESKTOPACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALWATCHVIDEOMOBILEACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALWATCHVIDEOMOBILEACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALWATCHVIDEOMOBILEACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALWATCHVIDEOTABLETACTIONTODESKTOPCONVERSIONIntegerTrueNo
TOTALWATCHVIDEOTABLETACTIONTOMOBILECONVERSIONIntegerTrueNo
TOTALWATCHVIDEOTABLETACTIONTOTABLETCONVERSIONIntegerTrueNo
TOTALWEBADDTOCARTIntegerTrueNo
TOTALWEBADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCHECKOUTIntegerTrueNo
TOTALWEBCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKADDTOCARTIntegerTrueNo
TOTALWEBCLICKADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKCHECKOUTIntegerTrueNo
TOTALWEBCLICKCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKCUSTOMIntegerTrueNo
TOTALWEBCLICKCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKLEADIntegerTrueNo
TOTALWEBCLICKLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKPAGEVISITIntegerTrueNo
TOTALWEBCLICKPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKSEARCHIntegerTrueNo
TOTALWEBCLICKSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKSIGNUPIntegerTrueNo
TOTALWEBCLICKSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKUNKNOWNIntegerTrueNo
TOTALWEBCLICKUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKVIEWCATEGORYStringTrueNo
TOTALWEBCLICKVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCLICKWATCHVIDEOIntegerTrueNo
TOTALWEBCLICKWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBCUSTOMIntegerTrueNo
TOTALWEBCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTADDTOCARTIntegerTrueNo
TOTALWEBENGAGEMENTADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTCHECKOUTIntegerTrueNo
TOTALWEBENGAGEMENTCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTCUSTOMIntegerTrueNo
TOTALWEBENGAGEMENTCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTLEADIntegerTrueNo
TOTALWEBENGAGEMENTLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTPAGEVISITIntegerTrueNo
TOTALWEBENGAGEMENTPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTSEARCHIntegerTrueNo
TOTALWEBENGAGEMENTSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTSIGNUPIntegerTrueNo
TOTALWEBENGAGEMENTSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTUNKNOWNIntegerTrueNo
TOTALWEBENGAGEMENTUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTVIEWCATEGORYStringTrueNo
TOTALWEBENGAGEMENTVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBENGAGEMENTWATCHVIDEOIntegerTrueNo
TOTALWEBENGAGEMENTWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBLEADIntegerTrueNo
TOTALWEBLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBPAGEVISITIntegerTrueNo
TOTALWEBPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBSEARCHIntegerTrueNo
TOTALWEBSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBSESSIONSIntegerTrueNo
TOTALWEBSIGNUPIntegerTrueNo
TOTALWEBSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBUNKNOWNStringTrueNo
TOTALWEBUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWADDTOCARTIntegerTrueNo
TOTALWEBVIEWADDTOCARTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWCATEGORYStringTrueNo
TOTALWEBVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWCHECKOUTIntegerTrueNo
TOTALWEBVIEWCHECKOUTVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWCUSTOMIntegerTrueNo
TOTALWEBVIEWCUSTOMVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWLEADIntegerTrueNo
TOTALWEBVIEWLEADVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWPAGEVISITIntegerTrueNo
TOTALWEBVIEWPAGEVISITVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWSEARCHIntegerTrueNo
TOTALWEBVIEWSEARCHVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWSIGNUPIntegerTrueNo
TOTALWEBVIEWSIGNUPVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWUNKNOWNStringTrueNo
TOTALWEBVIEWUNKNOWNVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWVIEWCATEGORYStringTrueNo
TOTALWEBVIEWVIEWCATEGORYVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBVIEWWATCHVIDEOIntegerTrueNo
TOTALWEBVIEWWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
TOTALWEBWATCHVIDEOIntegerTrueNo
TOTALWEBWATCHVIDEOVALUEINMICRODOLLARIntegerTrueNo
VIDEO3SECVIEWS1StringTrueNo
VIDEO3SECVIEWS2StringTrueNo
VIDEOAVGWATCHTIMEINSECOND1StringTrueNo
VIDEOAVGWATCHTIMEINSECOND2StringTrueNo
VIDEOLENGTHStringTrueNo
VIDEOMRCVIEWS1StringTrueNo
VIDEOMRCVIEWS2StringTrueNo
VIDEOP0COMBINED1StringTrueNo
VIDEOP0COMBINED2StringTrueNo
VIDEOP100COMPLETE1StringTrueNo
VIDEOP100COMPLETE2StringTrueNo
VIDEOP25COMBINED1StringTrueNo
VIDEOP25COMBINED2StringTrueNo
VIDEOP50COMBINED1StringTrueNo
VIDEOP50COMBINED2StringTrueNo
VIDEOP75COMBINED1StringTrueNo
VIDEOP75COMBINED2StringTrueNo
VIDEOP95COMBINED1StringTrueNo
VIDEOP95COMBINED2StringTrueNo
WEBADDTOCARTCOSTPERACTIONIntegerTrueNo
WEBADDTOCARTROASStringTrueNo
WEBCHECKOUTCOSTPERACTIONStringTrueNo
WEBCHECKOUTROASStringTrueNo
WEBCUSTOMCOSTPERACTIONIntegerTrueNo
WEBCUSTOMROASStringTrueNo
WEBLEADCOSTPERACTIONIntegerTrueNo
WEBLEADROASStringTrueNo
WEBPAGEVISITCOSTPERACTIONIntegerTrueNo
WEBPAGEVISITROASStringTrueNo
WEBSEARCHCOSTPERACTIONIntegerTrueNo
WEBSEARCHROASStringTrueNo
WEBSESSIONS1StringTrueNo
WEBSESSIONS2StringTrueNo
WEBSIGNUPCOSTPERACTIONIntegerTrueNo
WEBSIGNUPROASStringTrueNo
WEBUNKNOWNCOSTPERACTIONIntegerTrueNo
WEBUNKNOWNROASStringTrueNo
WEBVIEWCATEGORYCOSTPERACTIONIntegerTrueNo
WEBVIEWCATEGORYROASStringTrueNo
WEBWATCHVIDEOCOSTPERACTIONIntegerTrueNo
WEBWATCHVIDEOROASStringTrueNo
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ConversionReportTimeStringFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.
AttributionTypesStringFalseYesList of types of attribution for the conversion report
CampaignIdsStringFalseYesId of the campaign.
CampaignStatusesStringFalseYesList of status values for filtering
CampaignObjectiveTypesStringFalseYesList of status values for filtering
AdGroupIdsStringFalseYesId of the ad group.
AdGroupStatusesStringFalseYesList of values for filtering.
AdIdsStringFalseYesList of ad ids
AdStatusesStringFalseYesList of values for filtering.
ProductGroupIdsStringFalseYesList of product group ids.
ProductGroupStatusesStringFalseYesList of values for filtering.
TargetingTypesStringFalseYesTargeting type
AdsAnalyticsMetricsFilterStringFalseYesList of metrics filters
ProductItemIdsStringFalseYesList of product item ids.
AdsAnalyticsMetricsFilterStringFalseYesList of metrics filters

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the Ad Account.
NameStringTrueNoName of the Ad Account.
OwnerUsernameStringTrueNoOwner Usernameof the Ad Account.
CountryStringTrueNoCountry of the ad account.
CurrencyStringTrueNoCurrency of the ad account.
OwnerIdStringTrueNoOwner UserId of the ad account.
CreatedTimeDatetimeTrueNoCreated Time of the ad account.
UpdatedTimeDatetimeTrueNoUpdated Time of the ad account.
PermissionsStringTrueNoPermissions of the ad account.
IncludeSharedAccountsBooleanFalseYesInclude shared ad accounts

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
AdGroupIdStringTrueAdGroups.IdNoId of the ad group.
TargetingTypeStringTrueNoTargeting type.
TargetingValuesStringTrueNoTargeting type value.
DateDateTrueNoDate the analytics row covers.
SpendInDollarDecimalTrueNoTotal spend in dollars.
AdvertiserIdDoubleTrueNoId of the advertiser.
AdGroupEntityStatusDoubleTrueNoId of the advertiser.
AdIdDoubleTrueNoId of the advertiser.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
CampaignDailySpendCapStringTrueNoCampaign daily spend cap.
CampaignEntityStatusStringTrueNoCampaign entity status.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CtrDoubleTrueNoCtr.
Ctr2DoubleTrueNoCtr2.
CheckoutRoasDoubleTrueNoCheckout roas.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough2IntegerTrueNoClickthrough2.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EctrDecimalTrueNoEctr.
EcpeInDollarDecimalTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
EcpvInDollarDecimalTrueNoEcpv in dollars.
EcpcvInDollarDecimalTrueNoE Cpcv in Dollars.
EcpcvP95InDollarDecimalTrueNoE Cpcv 95 percent in Dollars.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PinIdStringTruePins.IdNoId of the Pins.
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
RepinRateDoubleTrueNoThe repin rate.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDecimalTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDecimalTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDecimalTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDecimalTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDecimalTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDecimalTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDecimalTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDecimalTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDecimalTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDecimalTrueNoTotal Web View Checkout Value In Micro Dollar.
Video3secViews2IntegerTrueNoVideo 3 second Views.
VideoLengthIntegerTrueNoVideoLength.
VideoMrcViews2IntegerTrueNoVideo 2 second Views.
VideoP0Combined2IntegerTrueNoVideo 0 percent Combined Views.
VideoP100Complete2IntegerTrueNoVideo 100 percent Complete Views.
VideoP25Combined2IntegerTrueNoVideo 25 percent Complete Views.
VideoP50Combined2IntegerTrueNoVideo 50 percent Complete Views.
VideoP75Combined2IntegerTrueNoVideo 75 percent Complete Views.
VideoP95Combined2IntegerTrueNoVideo 95 percent Complete Views.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity.
AttributionTypesStringFalseYesList of types of attribution for the conversion report.
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdIdStringTrueAds.IdNoId of the ad
AdAccountIdStringTrueAdAccounts.IdNoId of the ad account
DateDateTrueNoCurrent metrics date. Only returned when granularity is a time-based value.
CampaignEntityStatusStringTrueNoStatus of the campaign.
AdGroupEntityStatusStringTrueNoStatus of the ad group.
SpendInDollarDoubleTrueNoTotal spend in dollars.
EcpcInDollarDoubleTrueNoEcpc in dollars.
CtrDoubleTrueNoCtr.
EctrDoubleTrueNoEctr.
EcpeInDollarDoubleTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
RepinRateDoubleTrueNoThe repin rate.
Ctr2DoubleTrueNoCtr2
CpmInDollarDoubleTrueNoCpm in Dollars.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
CheckoutRoasDoubleTrueNoCheckout roas.
Video3secViews2IntegerTrueNoVideos with at least 3 seconds of viewing.
VideoP100Complete2IntegerTrueNoVideos 100 percent complete
VideoP0Combined2IntegerTrueNoVideos 0 percent combined viewed.
VideoP25Combined2IntegerTrueNoVideos 25 percent combined viewed.
VideoP50Combined2IntegerTrueNoVideo 50 percent combined viewed.
VideoP75Combined2IntegerTrueNoVideo 75 percent combined viewed.
VideoP95Combined2IntegerTrueNoVideo 95 percent combined viewed.
VideoMrcViews2IntegerTrueNoVideo Mrc Views.
EcpvInDollarDoubleTrueNoEcpv in dollars.
EcpcvInDollarDoubleTrueNoE Cpcv in Dollars
EcpcvP95InDollarDoubleTrueNoE Cpcv 95 percent in Dollars.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalImpressionFrequencyDoubleTrueNoTotal Impression Frequency.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDoubleTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDoubleTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDoubleTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDoubleTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDoubleTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDoubleTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDoubleTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDoubleTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDoubleTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDoubleTrueNoTotal Web View Checkout Value In Micro Dollar.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
AdvertiserIdStringTrueNoId of the ad account
AdGroupIdStringTrueAdGroups.IdNoId of the ad group.
CampaignDailySpendCapIntegerTrueNoCampaign daily spend cap.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CampaignNameStringTrueNoName of the Campaign
Clickthrough2IntegerTrueNoClickthrough2.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
Impression2IntegerTrueNoImpression2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PaidImpressionIntegerTrueNoPaidImpression.
PinIdStringTruePins.IdNoId of the Pins.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
SpendInMicroDollarDecimalTrueNoTotal spend in dollars.
TotalClickAddToCartIntegerTrueNoTotal click add to cart.
TotalClickLeadIntegerTrueNoTotal click lead.
TotalCustomIntegerTrueNoTotal custom.
TotalEngagementIntegerTrueNoTotal Engagement.
TotalEngagementLeadIntegerTrueNoTotal Engagement Lead.
TotalIdeaPinProductTagVisitIntegerTrueNoTotal Idea Pin Product Tag Visit.
TotalImpressionUserIntegerTrueNoTotal Impression User.
TotalLeadIntegerTrueNoTotal Lead.
TotalOfflineCheckoutIntegerTrueNoTotal offline checkout.
TotalViewAddToCartIntegerTrueNoTotal view add to cart.
TotalViewLeadIntegerTrueNoTotal view Lead.
TotalWebSessionsIntegerTrueNoTotal web sessions.
VideoLengthIntegerTrueNoVideoLength.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeStringFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CampaignIdStringTrueCampaigns.IdNoId of the campaign.
AdAccountIdStringTrueAdAccounts.IdNoId of the ad account.
DateDateTrueNoDate the analytics row covers.
CampaignEntityStatusStringTrueNoStatus of the campaign.
AdGroupEntityStatusStringTrueNoStatus of the ad group.
SpendInDollarDoubleTrueNoTotal spend in dollars.
EcpcInDollarDoubleTrueNoEcpc in dollars.
CtrDoubleTrueNoCtr.
EctrDoubleTrueNoEctr.
EcpeInDollarDoubleTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
RepinRateDoubleTrueNoThe repin rate.
Ctr2DoubleTrueNoCtr2
CpmInDollarDoubleTrueNoCpm in Dollars.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
CheckoutRoasDoubleTrueNoCheckout roas.
Video3secViews2IntegerTrueNoVideos with at least 3 seconds of viewing.
VideoP100Complete2IntegerTrueNoVideos 100 percent complete
VideoP0Combined2IntegerTrueNoVideos 0 percent combined viewed.
VideoP25Combined2IntegerTrueNoVideos 25 percent combined viewed.
VideoP50Combined2IntegerTrueNoVideo 50 percent combined viewed.
VideoP75Combined2IntegerTrueNoVideo 75 percent combined viewed.
VideoP95Combined2IntegerTrueNoVideo 95 percent combined viewed.
VideoMrcViews2IntegerTrueNoVideo Mrc Views.
EcpvInDollarDoubleTrueNoEcpv in dollars.
EcpcvInDollarDoubleTrueNoE Cpcv in Dollars
EcpcvP95InDollarDoubleTrueNoE Cpcv 95 percent in Dollars.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalImpressionFrequencyDoubleTrueNoTotal Impression Frequency.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDoubleTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDoubleTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDoubleTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDoubleTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDoubleTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDoubleTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDoubleTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDoubleTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDoubleTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDoubleTrueNoTotal Web View Checkout Value In Micro Dollar.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
AdIdStringTrueAds.IdNoId of the Ad.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeStringFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdGroupIdStringTrueAdGroups.IdNoId of the ad group.
AdAccountIdStringTrueAdAccounts.IdNoId of the ad account.
DateDateTrueNoDate the analytics row covers.
CampaignEntityStatusStringTrueNoStatus of the campaign.
AdGroupEntityStatusStringTrueNoStatus of the ad group.
SpendInDollarDoubleTrueNoTotal spend in dollars.
EcpcInDollarDoubleTrueNoEcpc in dollars.
CtrDoubleTrueNoCtr.
EctrDoubleTrueNoEctr.
EcpeInDollarDoubleTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
RepinRateDoubleTrueNoThe repin rate.
Ctr2DoubleTrueNoCtr2
CpmInDollarDoubleTrueNoCpm in Dollars.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
CheckoutRoasDoubleTrueNoCheckout roas.
Video3secViews2IntegerTrueNoVideos with at least 3 seconds of viewing.
VideoP100Complete2IntegerTrueNoVideos 100 percent complete
VideoP0Combined2IntegerTrueNoVideos 0 percent combined viewed.
VideoP25Combined2IntegerTrueNoVideos 25 percent combined viewed.
VideoP50Combined2IntegerTrueNoVideo 50 percent combined viewed.
VideoP75Combined2IntegerTrueNoVideo 75 percent combined viewed.
VideoP95Combined2IntegerTrueNoVideo 95 percent combined viewed.
VideoMrcViews2IntegerTrueNoVideo Mrc Views.
EcpvInDollarDoubleTrueNoEcpv in dollars.
EcpcvInDollarDoubleTrueNoE Cpcv in Dollars
EcpcvP95InDollarDoubleTrueNoE Cpcv 95 percent in Dollars.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalImpressionFrequencyDoubleTrueNoTotal Impression Frequency.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDoubleTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDoubleTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDoubleTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDoubleTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDoubleTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDoubleTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDoubleTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDoubleTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDoubleTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDoubleTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDoubleTrueNoTotal Web View Checkout Value In Micro Dollar.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
TotalImpressionUserIntegerTrueNoTotal ImpressionUser.
CampaignDailySpendCapIntegerTrueNoCampaign Daily Spend Cap.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
Clickthrough2IntegerTrueNoClickthrough2.
CpcInMicroDollarDoubleTrueNoCpc In MicroDollar.
CpmInMicroDollarDoubleTrueNoCpm In MicroDollar.
EcpcInMicroDollarDoubleTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDoubleTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
SpendInMicroDollarDoubleTrueNoSpend In MicroDollar.
TotalClickAddToCartIntegerTrueNoTotal Click Add To Cart.
TotalClickLeadIntegerTrueNoTotal ClickLead.
TotalCustomIntegerTrueNoTotal Custom.
TotalEngagementIntegerTrueNoTotal Engagement.
TotalEngagementLeadIntegerTrueNoTotal Engagement Lead.
TotalIdeaPinProductTagVisitIntegerTrueNoTotal Idea Pin Product Tag Visit.
TotalLeadIntegerTrueNoTotal Lead.
TotalOfflineCheckoutIntegerTrueNoTotal Offline Checkout.
TotalViewAddToCartIntegerTrueNoTotal View Add To Cart.
TotalViewLeadIntegerTrueNoTotal View Lead.
TotalWebSessionsIntegerTrueNoTotal Web Sessions.
VideoLengthIntegerTrueNoVideoLength.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
AdIdStringTrueAds.IdNoId of the Ad.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoAdvertiser ID.
AdAccountIdStringTrueAdAccounts.IdNoAd Account ID.
CampaignIdStringTrueCampaigns.IdNoCampaign ID of the ad group.
FeedProfileIdStringTrueNoFeed Profile ID associated to the adgroup.
AutoTargetingEnabledBooleanTrueNoEnable auto-targeting for ad group.
BidInMicroCurrencyIntegerTrueNoBid price in micro currency.
BillableEventStringTrueNoAd group billable event type.
BudgetInMicroCurrencyIntegerTrueNoBudget in micro currency.
BudgetTypeStringTrueNoBudget type
ConversionLearningModeTypeStringTrueNooCPM learn mode
CreatedTimeDatetimeTrueNoAd group creation time.
EndTimeDatetimeTrueNoAd group end time.
LifetimeFrequencyCapIntegerTrueNoSet 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.
NameStringTrueNoAd group name.
PacingDeliveryTypeStringTrueNoPacingDeliveryType
PlacementGroupStringTrueNoPlacementGroup
StartTimeDatetimeTrueNoAd group start time
StatusStringTrueNoAd group/entity status.
SummaryStatusStringTrueNoAd group summary status.
TargetingSpecStringTrueNoAd group targeting specification defining the ad group target audience.
TrackingUrlsAudienceVerificationStringTrueNoThird-party tracking URLs.
TrackingUrlsBuyableButtonStringTrueNoThird-party tracking URLs.
TrackingUrlsClickStringTrueNoThird-party tracking URLs.
TrackingUrlsEngagementStringTrueNoThird-party tracking URLs.
TrackingUrlsImpressionStringTrueNoThird-party tracking URLs.
TypeStringTrueNoType of ad group.
UpdatedTimeDatetimeTrueNoAd group last update time.
TranslateInterestsToNamesBooleanFalseYesReturn interests as text names and not topic IDs?

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
AdGroupIdStringTrueAdGroups.IdNoId of the ad group.
TargetingTypeStringTrueNoTargeting type.
TargetingValuesStringTrueNoTargeting type value.
DateDateTrueNoDate the analytics row covers.
SpendInDollarDecimalTrueNoTotal spend in dollars.
AdvertiserIdDoubleTrueNoId of the advertiser.
AdGroupEntityStatusDoubleTrueNoId of the advertiser.
AdIdDoubleTrueNoId of the advertiser.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
CampaignDailySpendCapStringTrueNoCampaign daily spend cap.
CampaignEntityStatusStringTrueNoCampaign entity status.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CtrDoubleTrueNoCtr.
Ctr2DoubleTrueNoCtr2.
CheckoutRoasDoubleTrueNoCheckout roas.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough2IntegerTrueNoClickthrough2.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EctrDecimalTrueNoEctr.
EcpeInDollarDecimalTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
EcpvInDollarDecimalTrueNoEcpv in dollars.
EcpcvInDollarDecimalTrueNoE Cpcv in Dollars.
EcpcvP95InDollarDecimalTrueNoE Cpcv 95 percent in Dollars.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PinIdStringTruePins.IdNoId of the Pins.
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
RepinRateDoubleTrueNoThe repin rate.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDecimalTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDecimalTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDecimalTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDecimalTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDecimalTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDecimalTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDecimalTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDecimalTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDecimalTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDecimalTrueNoTotal Web View Checkout Value In Micro Dollar.
Video3secViews2IntegerTrueNoVideo 3 second Views.
VideoLengthIntegerTrueNoVideoLength.
VideoMrcViews2IntegerTrueNoVideo 2 second Views.
VideoP0Combined2IntegerTrueNoVideo 0 percent Combined Views.
VideoP100Complete2IntegerTrueNoVideo 100 percent Complete Views.
VideoP25Combined2IntegerTrueNoVideo 25 percent Complete Views.
VideoP50Combined2IntegerTrueNoVideo 50 percent Complete Views.
VideoP75Combined2IntegerTrueNoVideo 75 percent Complete Views.
VideoP95Combined2IntegerTrueNoVideo 95 percent Complete Views.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity.
AttributionTypesStringFalseYesList of types of attribution for the conversion report.
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe ID of this ad.
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
AdGroupIdStringTrueAdGroups.IdNoID of the ad group that contains the ad.
AndroidDeepLinkStringTrueNoDeep link URL for Android devices. Not currently available. Using this field will generate an error.
CampaignIdStringTrueCampaigns.IdNoID of the ad campaign that contains this ad.
CarouselAndroidDeepLinksStringTrueNoComma-separated deep links for the carousel pin on Android.
CarouselDestinationUrlsStringTrueNoComma-separated destination URLs for the carousel pin to promote.
CarouselIosDeepLinksStringTrueNoComma-separated deep links for the carousel pin on iOS.
ClickTrackingUrlStringTrueNoTracking url for the ad clicks.
CollectionItemsDestinationUrlTemplateStringTrueNoDestination URL template for all items within a collections drawer.
CreatedTimeDatetimeTrueNoPin creation time.
CreativeTypeStringTrueNoAd creative type
DestinationUrlStringTrueNoDestination URL.
IosDeepLinkStringTrueNoDeep link URL for iOS devices.
IsPinDeletedBooleanTrueNoIs original pin deleted?
IsRemovableBooleanTrueNoIs pin repinnable?
NameStringTrueNoName of the ad.
PinIdStringTrueNoPin ID.
RejectedReasonsStringTrueNoReason why the pin was rejected.
RejectionLabelsStringTrueNoText reason why the pin was rejected.
ReviewStatusStringTrueNoAd review status
StatusStringTrueNoEntity status
SummaryStatusStringTrueNoAd summary status.
TrackingUrlsAudienceVerificationStringTrueNoTracking Urls Audience Verification.
TrackingUrlsBuyableButtonStringTrueNoTracking Urls Buyable Button.
TrackingUrlsClickStringTrueNoTracking Urls Click.
TrackingUrlsEngagementStringTrueNoTracking Urls Engagement.
TrackingUrlsImpressionStringTrueNoTracking Urls Impression.
TypeStringTrueNoType of ad.
UpdatedTimeDatetimeTrueNoLast update time.
ViewTrackingUrlStringTrueNoTracking URL for ad impressions.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
AdIdStringTrueAds.IdNoId of the ad
TargetingTypeStringTrueNoTargeting type.
TargetingValuesStringTrueNoTargeting type value.
DateDateTrueNoDate the analytics row covers.
SpendInDollarDecimalTrueNoTotal spend in dollars.
AdvertiserIdDoubleTrueNoId of the advertiser.
AdGroupEntityStatusDoubleTrueNoId of the advertiser.
MetricsAdIdStringTrueAds.IdNoId of the ad
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
CampaignDailySpendCapStringTrueNoCampaign daily spend cap.
CampaignEntityStatusStringTrueNoCampaign entity status.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CtrDoubleTrueNoCtr.
Ctr2DoubleTrueNoCtr2.
CheckoutRoasDoubleTrueNoCheckout roas.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough2IntegerTrueNoClickthrough2.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EctrDecimalTrueNoEctr.
EcpeInDollarDecimalTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
EcpvInDollarDecimalTrueNoEcpv in dollars.
EcpcvInDollarDecimalTrueNoE Cpcv in Dollars.
EcpcvP95InDollarDecimalTrueNoE Cpcv 95 percent in Dollars.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PinIdStringTruePins.IdNoId of the Pins.
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
RepinRateDoubleTrueNoThe repin rate.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDecimalTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDecimalTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDecimalTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDecimalTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDecimalTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDecimalTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDecimalTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDecimalTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDecimalTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDecimalTrueNoTotal Web View Checkout Value In Micro Dollar.
Video3secViews2IntegerTrueNoVideo 3 second Views.
VideoLengthIntegerTrueNoVideoLength.
VideoMrcViews2IntegerTrueNoVideo 2 second Views.
VideoP0Combined2IntegerTrueNoVideo 0 percent Combined Views.
VideoP100Complete2IntegerTrueNoVideo 100 percent Complete Views.
VideoP25Combined2IntegerTrueNoVideo 25 percent Complete Views.
VideoP50Combined2IntegerTrueNoVideo 50 percent Complete Views.
VideoP75Combined2IntegerTrueNoVideo 75 percent Complete Views.
VideoP95Combined2IntegerTrueNoVideo 95 percent Complete Views.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity.
AttributionTypesStringFalseYesList of types of attribution for the conversion report.
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TypeStringTrueNoType of audience insights.
DateDatetimeTrueNoGeneration date.
SizeIntegerTrueNoPopulation count.
SizeIsUpperBoundBooleanTrueNoIndicates whether the audience size has been rounded up to the next highest upper boundary.
CategoriesStringTrueNoCategories.
DemographicsStringTrueNoAudience demographics.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
DateDatetimeTrueNoGeneration date.
TypeStringTrueNoType.
ScopeStringTrueNoScope.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoAudience ID.
AdAccountIdStringTrueAdAccounts.IdNoAd account ID.
NameStringTrueNoAudience name.
AudienceTypeStringTrueNoAudience Types.
DescriptionStringTrueNoAudience description.
RuleCountryStringTrueNoValid countries include: US,CA, and GB.
RuleCustomerListIdStringTrueNoCustomer list ID. For CUSTOMER_LIST audience_type.
RuleEngagementDomainStringTrueNoEngagement domain.
RuleEngagementTypeStringTrueNoEngagement type enum. Optional for ENGAGEMENT audience_type.
RuleEventStringTrueNoA Pinterest tag event. Optional for VISITOR audience_type.
RuleEventDataCurrencyStringTrueNoCurrency Codes from ISO 4217.
RuleEventDataLeadTypeStringTrueNoPromotion code.
RuleEventDataLineItemsProductBrandStringTrueNoProduct brand.
RuleEventDataLineItemsProductCategoryStringTrueNoProduct category.
RuleEventDataLineItemsProductIdIntegerTrueNoProduct ID.
RuleEventDataLineItemsProductNameStringTrueNoProduct name.
RuleEventDataLineItemsProductPriceStringTrueNoProduct price.
RuleEventDataLineItemsProductQuantityIntegerTrueNoProduct quantity.
RuleEventDataLineItemsProductVariantStringTrueNoProduct variant.
RuleEventDataLineItemsProductVariantIdStringTrueNoProduct variant ID.
RuleEventDataOrderIdStringTrueNoOrder ID.
RuleEventDataOrderQuantityIntegerTrueNoOrder quantity.
RuleEventDataPageNameStringTrueNoPage name.
RuleEventDataPromoCodeStringTrueNoPromotion code.
RuleEventDataPropertyStringTrueNoProperty.
RuleEventDataSearchQueryStringTrueNoSearch query string.
RuleEventDataValueStringTrueNoProduct value.
RuleEventDataVideoTitleStringTrueNoVideo title.
RulePercentageIntegerTrueNoPercentage should be 1-10. The targeted audience should be this % size across Pinterest.
RulePinIdStringTrueNoPin Id.
RulePrefillBooleanTrueNoOptional for VISITOR audience_type. The default is true.
RuleRetentionDaysIntegerTrueNoNumber of days a Pinterest user remains in the audience. Optional for ENGAGEMENT and VISITOR audience_type.
RuleSeedIdStringTrueNoSeed Id.
RuleUrlStringTrueNoUrl.
RuleVisitorSourceIdStringTrueNoThe conversion tag ID, or the Pinterest tag ID, that you use on your website. For VISITOR audience_type.
RuleEventSourceStringTrueNoOptional for VISITOR. You can use it as a {'=': [value]}.
RuleIngestionSourceStringTrueNoOptional for VISITOR. You can use it as a {'=': [value]}. Supported values are: tag, mmp, file_upload, conversions_api
RuleEngagerTypeIntegerTrueNoOptional for ENGAGEMENT. Engager type value should be 1-2.
RuleCampaignIdStringTrueNoCampaign Id.
RuleAdIdStringTrueNoAd Id.
RuleObjectiveTypeStringTrueNoObjective Type.
RuleAdAccountIdStringTrueNoAd account ID.
SizeIntegerTrueNoAudience size.
StatusStringTrueNoAudience status.
TypeStringTrueNoAlways
CreatedTimeDatetimeTrueNoCreation time. Unix timestamp in seconds.
UpdatedTimeDatetimeTrueNoLast update time. Unix timestamp in seconds.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the Board
NameStringTrueNoName of the Board
DescriptionStringTrueNoDescription of the Board
OwnerUsernameStringTrueNoUserName of the Owner.
PrivacyStringTrueNoPrivacy setting for the board.
MediaImageCoverUrlStringTrueNoMedia image cover url for the board.
MediaPinThumbnailUrlsStringTrueNoPin thumbnail urls for the board.
PinCountIntegerTrueNoPin count.
FollowerCountIntegerTrueNoFollower count.
CollaboratorCountIntegerTrueNoCollaborator count.
CreatedAtDatetimeTrueNoCreated Time.
BoardPinsModifiedAtDatetimeTrueNoModified Time.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the Section.
NameStringTrueNoName of the Section.
BoardIdStringTrueBoards.IdNoId of the Board.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoCampaign ID.
AdAccountIdStringTrueAdAccounts.IdNoCampaign's Advertiser ID.
CreatedTimeDatetimeTrueNoCampaign creation time.
DailySpendCapIntegerTrueNoCampaign total spending cap.
LifetimeSpendCapIntegerTrueNoCampaign daily spending cap.
NameStringTrueNoCampaign name.
ObjectiveTypeStringTrueNoCampaign objective type.
OrderLineIdStringTrueNoOrder line ID that appears on the invoice.
StatusStringTrueNoEntity status.
TrackingUrlsAudienceVerificationStringTrueNoTracking Urls Audience Verification.
TrackingUrlsBuyableButtonStringTrueNoTracking Urls Buyable Button.
TrackingUrlsClickStringTrueNoTracking Urls Click.
TrackingUrlsEngagementStringTrueNoTracking Urls Engagement
TrackingUrlsImpressionStringTrueNoTracking Urls Impression.
TypeStringTrueNoType of campaign.
UpdatedTimeDatetimeTrueNoLast update time.
StartTimeDatetimeTrueNoStart time.
EndTimeDatetimeTrueNoEnd time.
SummaryStatusStringTrueNoSummary status.
IsFlexibleDailyBudgetsBooleanTrueNoIs Flexible Daily Budgets.
IsCampaignBudgetOptimizationBooleanTrueNoIs Campaign Budget Optimization.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
TargetingTypeStringTrueNoTargeting type.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
TargetingValuesStringTrueNoTargeting type value.
DateDateTrueNoDate the analytics row covers.
SpendInDollarDecimalTrueNoTotal spend in dollars.
AdvertiserIdDoubleTrueNoId of the advertiser.
AdGroupEntityStatusDoubleTrueNoId of the advertiser.
AdIdDoubleTrueNoId of the advertiser.
MetricCampaignIdStringTrueCampaigns.IdNoId of the Campaign.
CampaignDailySpendCapStringTrueNoCampaign daily spend cap.
CampaignEntityStatusStringTrueNoCampaign entity status.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CtrDoubleTrueNoCtr.
Ctr2DoubleTrueNoCtr2.
CheckoutRoasDoubleTrueNoCheckout roas.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough2IntegerTrueNoClickthrough2.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EctrDecimalTrueNoEctr.
EcpeInDollarDecimalTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
EcpvInDollarDecimalTrueNoEcpv in dollars.
EcpcvInDollarDecimalTrueNoE Cpcv in Dollars.
EcpcvP95InDollarDecimalTrueNoE Cpcv 95 percent in Dollars.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PinIdStringTruePins.IdNoId of the Pins.
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
RepinRateDoubleTrueNoThe repin rate.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDecimalTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDecimalTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDecimalTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDecimalTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDecimalTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDecimalTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDecimalTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDecimalTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDecimalTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDecimalTrueNoTotal Web View Checkout Value In Micro Dollar.
Video3secViews2IntegerTrueNoVideo 3 second Views.
VideoLengthIntegerTrueNoVideoLength.
VideoMrcViews2IntegerTrueNoVideo 2 second Views.
VideoP0Combined2IntegerTrueNoVideo 0 percent Combined Views.
VideoP100Complete2IntegerTrueNoVideo 100 percent Complete Views.
VideoP25Combined2IntegerTrueNoVideo 25 percent Complete Views.
VideoP50Combined2IntegerTrueNoVideo 50 percent Complete Views.
VideoP75Combined2IntegerTrueNoVideo 75 percent Complete Views.
VideoP95Combined2IntegerTrueNoVideo 95 percent Complete Views.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity.
AttributionTypesStringFalseYesList of types of attribution for the conversion report.
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CatalogIdStringTrueNoUnique identifier of a catalog.
CatalogNameStringTrueNoCatalogName.
DataSourceIdStringTrueNoDataSourceId.
DataSourceNameStringTrueNoDataSourceName.
MerchantHotelIdStringTrueNoMerchantHotelId.
NameStringTrueNoName.
IneligibleForOrganicStringTrueNoIneligibleForOrganic.
IneligibleForAdsStringTrueNoIneligibleForAds.
CodeLabelStringTrueNoCodeLabel.
MessageStringTrueNoMessage.
LinkStringTrueNoLink.
ImageLinkStringTrueNoImageLink.
CatalogTypeStringFalseYesType of the catalog entity.
ReportTypeStringFalseYesReport Type.
FeedIdStringFalseYesID of the feed entity.
ProcessingResultIdStringFalseYesUnique identifier of a feed processing result.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ItemId [KEY]StringTrueNoThe merchant-created unique ID that represents the product.
FeedProcessingResultIdStringTrueFeedProcessingResults.IdNoUnique identifier of a feed processing result.
ItemNumberIntegerTrueNoItem number based on order of appearance in the Catalogs Feed.
ErrorAdultInvalidNameStringTrueNoItem attribute that has an invalid adult value.
ErrorAdultInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorAdwordsFormatInvalidNameStringTrueNoItem has an ad link URL that is duplicate of the link URL.
ErrorAdwordsFormatInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorAvailabilityInvalidNameStringTrueNoItem is missing availability value in its product metadata, this item will not be published.
ErrorAvailabilityInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorBlocklistedImageSignatureNameStringTrueNoItem will not be published because it doesn't meet Pinterest's Merchant Guidelines.
ErrorBlocklistedImageSignatureValueStringTrueNoProvided value that caused the validation issue.
ErrorDescriptionMissingNameStringTrueNoItem is missing description in its product metadata, this item will not be published.
ErrorDescriptionMissingValueStringTrueNoProvided value that caused the validation issue.
ErrorDuplicateProductsNameStringTrueNoThis product is duplicated. The duplicate entry will not be published.
ErrorDuplicateProductsValueStringTrueNoProvided value that caused the validation issue.
ErrorImageLinkInvalidNameStringTrueNoImage link is invalid.
ErrorImageLinkInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorImageLinkLengthTooLongNameStringTrueNoItem has image_link URL that contains too many characters, so the item will not be published.
ErrorImageLinkLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
ErrorImageLinkMissingNameStringTrueNoItem is missing an image link URL in its product metadata, this item will not be published.
ErrorImageLinkMissingValueStringTrueNoProvided value that caused the validation issue.
ErrorInvalidDomainNameStringTrueNoProduct link value doesn't match the verified domain associated with this account.
ErrorInvalidDomainValueStringTrueNoProvided value that caused the validation issue.
ErrorItemIdMissingNameStringTrueNoItem is missing item id in its product metadata, this item will not be published.
ErrorItemIdMissingValueStringTrueNoProvided value that caused the validation issue.
ErrorItemMainImageDownloadFailureNameStringTrueNoMain image can't be found.
ErrorItemMainImageDownloadFailureValueStringTrueNoProvided value that caused the validation issue.
ErrorLinkFormatInvalidNameStringTrueNoLink is invalid.
ErrorLinkFormatInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorLinkLengthTooLongNameStringTrueNoProduct link contains too many characters, this item will not be published.
ErrorLinkLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
ErrorListPriceInvalidNameStringTrueNoItem has a list price formatting error, this item will not be published.
ErrorListPriceInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorMaxItemsPerItemGroupExceededNameStringTrueNoItem exceed the maximum number of items per item group, this item will not be published.
ErrorMaxItemsPerItemGroupExceededValueStringTrueNoProvided value that caused the validation issue.
ErrorParseLineErrorNameStringTrueNoItem contains formating errors.
ErrorParseLineErrorValueStringTrueNoProvided value that caused the validation issue.
ErrorPinJoinContentUnsafeNameStringTrueNoItem will not be published because it doesn't meet Pinterest's Merchant Guidelines.
ErrorPinJoinContentUnsafeValueStringTrueNoProvided value that caused the validation issue.
ErrorPriceCannotBeDeterminedNameStringTrueNoItem price cannot be determined because the price, list price, and sale price are all different.
ErrorPriceCannotBeDeterminedValueStringTrueNoProvided value that caused the validation issue.
ErrorPriceMISSINGNameStringTrueNoProduct is missing a price, this item will not be published.
ErrorPriceMISSINGValueStringTrueNoProvided value that caused the validation issue.
ErrorProductLinkMissingNameStringTrueNoItem is missing a link URL in its product metadata, this item will not be published.
ErrorProductLinkMissingValueStringTrueNoProvided value that caused the validation issue.
ErrorProductPriceInvalidNameStringTrueNoItem has a price formatting error in its product metadata, this item will not be published.
ErrorProductPriceInvalidValueStringTrueNoProvided value that caused the validation issue.
ErrorTitleMissingNameStringTrueNoItem is missing title in its product metadata, this item will not be published.
ErrorTitleMissingValueStringTrueNoProvided value that caused the validation issue.
WarningAdLinkFormatWarningNameStringTrueNoItem has an ad link that is formatted incorrectly.
WarningAdLinkFormatWarningValueStringTrueNoProvided value that caused the validation issue.
WarningAdLinkSameAsLinkNameStringTrueNoItem has an ad link URL that is duplicate of the link URL.
WarningAdLinkSameAsLinkValueStringTrueNoProvided value that caused the validation issue.
WarningAdditionalImageLinkLengthTooLongNameStringTrueNoItem has an additional_image_link URL that contains too many characters, so the item will not be published.
WarningAdditionalImageLinkLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
WarningAdditionalImageLinkWarningNameStringTrueNoItem has additional_image_link URLs that are formatted incorrectly and will not be published with your items.
WarningAdditionalImageLinkWarningValueStringTrueNoProvided value that caused the validation issue.
WarningAdwordsFormatWarningNameStringTrueNoItem has an adwords_redirect link that is formatted incorrectly.
WarningAdwordsFormatWarningValueStringTrueNoProvided value that caused the validation issue.
WarningAdwordsSameAsLinkNameStringTrueNoItem has an adwords_redirect URL that is duplicate of the link URL.
WarningAdwordsSameAsLinkValueStringTrueNoProvided value that caused the validation issue.
WarningAgeGroupInvalidNameStringTrueNoItem has an age group value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningAgeGroupInvalidDValueStringTrueNoProvided value that caused the validation issue.
WarningSizeSystemInvalidNameStringTrueNoSome items have size system values which are not one of the supported size systems.
WarningSizeSystemInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningAndroidDeepLinkInvalidNameStringTrueNoItem includes an invalid android_deep_link.
WarningAndroidDeepLinkInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningAvailabilityDateInvalidNameStringTrueNoItem has an availability_date value that is formatted incorrectly, this item will be published without an availability date.
WarningAvailabilityDateInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningConutryDoesNotMapToCurrencyNameStringTrueNoItem includes a currency that doesn't match the usual currency for the location where the product is sold or shipped.
WarningCountryDoesNotMapToCurrencyValueStringTrueNoProvided value that caused the validation issue.
WarningCustomLabelLengthTooLongNameStringTrueNoItem has a custom_label value that is too long, this item will be published without that custom label.
WarningCustomLabelLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
WarningDescriptionLengthTooLongNameStringTrueNoThe description for this item was truncated because it contains too many characters.
WarningDescriptionLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
WarningExpirationDateInvalidNameStringTrueNoItem has an expiration_date value that is formatted incorrectly, this item will be published without an expiration date.
WarningExpirationDateInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningGenderInvalidNameStringTrueNoItem has a gender value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningGenderInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningGTINInvalidNameStringTrueNoItem has a GTIN value that is formatted incorrectly.
WarningGTINInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningImageLinkWarningNameStringTrueNoItem has an image_link URL that is formatted incorrectly and will not be published.
WarningImageLinkWarningValueStringTrueNoProvided value that caused the validation issue.
WarningIOSDeepLinkInvalidNameStringTrueNoItem includes an invalid ios_deep_link value.
WarningIOSDeepLinkInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningIsBundleInvalidNameStringTrueNoItem has an is_bundle value that is formatted incorrectly, this item will be published without being bundled with other products.
WarningIsBundleInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningItemAdditionalImageDownloadFailureNameStringTrueNoItem includes additional_image_links that can't be found.
WarningItemAdditionalImageDownloadFailureValueStringTrueNoProvided value that caused the validation issue.
WarningLinkFormatWarningNameStringTrueNoItem has an invalid product link which contains invalid UTM tracking paramaters.
WarningLinkFormatWarningValueStringTrueNoProvided value that caused the validation issue.
WarningMinAdPriceInvalidNameStringTrueNoItem includes a min_ad_price value that is formatted incorrectly.
WarningMinAdPriceInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningMPNInvalidNameStringTrueNoItem has a MPN value that is formatted incorrectly.
WarningMPNInvalidValueStringTrueNoProvided value that caused the validation issue..
WarningMultipackInvalidNameStringTrueNoItem has an invalid multipack value.
WarningMultipackInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningOptionalConditionInvalidNameStringTrueNoItem includes a condition value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningOptionalConditionInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningOptionalConditionMissingNameStringTrueNoItem is missing condition value, which may limit visibility in recommendations, search results and shopping experiences.
WarningOptionalConditionMissingValueStringTrueNoProvided value that caused the validation issue.
WarningOptionalProductCategoryInvalidNameStringTrueNoItem includes a google_product_category value that is not formatted correctly according to the GPC taxonomy.
WarningOptionalProductCategoryInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningOptionalProductCategoryMissingNameStringTrueNoItem is missing google_product_category.
WarningOptionalProductCategoryMissingValueStringTrueNoProvided value that caused the validation issue.
WarningProductCategoryDepthWarningNameStringTrueNoItem only has 1 or 2 levels of google_product_category value, which may limit visibility in recommendations, search results and shopping experiences.
WarningProductCategoryDepthWarningValueStringTrueNoProvided value that caused the validation issue.
WarningProductTypeLengthTooLongNameStringTrueNoItem has a product_type value that is too long, this item will be published without that product type.
WarningProductTypeLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
WarningSalesPriceInvalidNameStringTrueNoItem has an incorrectly formatted sales price.
WarningSalesPriceInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningSalesPriceTooLowNameStringTrueNoItem has a sale price value that is discounted very low compared to the price.
WarningSalesPriceTooLowValueStringTrueNoProvided value that caused the validation issue.
WarningSalesPriceTooHighNameStringTrueNoItem has a sale price value that is higher than the original price of the item.
WarningSalesPriceTooHighValueStringTrueNoProvided value that caused the validation issue.
WarningSaleDateInvalidNameStringTrueNoItem has a sale_price_effective_date value that is formatted incorrectly, this item will be published without a sale date.
WarningSaleDateInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningShippingInvalidNameStringTrueNoItem has a shipping value that is formatted incorrectly.
WarningShippingInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningShippingHeightInvalidNameStringTrueNoItem has an incorrectly formatted shipping_height value. The value must first contain a numeric value then a valid dimension unit type.
WarningShippingHeightInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningShippingWeightInvalidNameStringTrueNoItem has an invalid shipping_weight value.
WarningShippingWeightInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningShippingWidthInvalidNameStringTrueNoItem has an incorrectly formatted shipping_width value. The value must first contain a numeric value then a valid dimension unit type.
WarningShippingWidthInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningSizeTypeInvalidNameStringTrueNoItem has a size type value that is formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
WarningSizeTypeInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningTaxInvalidNameStringTrueNoItem has a tax value that is formatted incorrectly.
WarningTaxInvalidValueStringTrueNoProvided value that caused the validation issue.
WarningTitleLengthTooLongNameStringTrueNoThe title for the item was truncated because it contains too many characters.
WarningTitleLengthTooLongValueStringTrueNoProvided value that caused the validation issue.
WarningTooManyAdditionalImageLinksNameStringTrueNoItem has a additional_image_link value that exceed the limit for additional images, this item will be published without some of your images.
WarningTooManyAdditionalImageLinksValueStringTrueNoProvided value that caused the validation issue.
WarningUTMSourceAutoCorrectedNameStringTrueNoItem includes an utm_source value that is formatted incorrectly and has been automatically corrected.
WarningUTMSourceAutoCorrectedValueStringTrueNoProvided value that caused the validation issue.
WarningWeightUnitInvalidNameStringTrueNoItem has a weight_unit value that is formatted incorrectly, this item will be published without a weight unit.
WarningWeightUnitInvalidValueStringTrueNoProvided value that caused the validation issue.
AdAccountIdStringFalseYesUnique identifier of an ad account.
ItemValidationIssueStringFalseYesFilter item validation issues that have a given type of item validation issue.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CatalogIdStringTrueNoUnique identifier of a catalog.
CatalogNameStringTrueNoCatalogName.
DataSourceIdStringTrueNoDataSourceId.
DataSourceNameStringTrueNoDataSourceName.
ItemIdStringTrueNoItemId.
TitleStringTrueNoTitle.
IneligibleForOrganicStringTrueNoIneligibleForOrganic.
IneligibleForAdsStringTrueNoIneligibleForAds.
CodeLabelStringTrueNoCodeLabel.
MessageStringTrueNoMessage.
LinkStringTrueNoLink.
ImageLinkStringTrueNoImageLink.
PriceStringTrueNoPrice.
AvailabilityStringTrueNoAvailability.
CatalogTypeStringFalseYesType of the catalog entity.
ReportTypeStringFalseYesReport Type.
FeedIdStringFalseYesID of the feed entity.
ProcessingResultIdStringFalseYesUnique identifier of a feed processing result.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID of the catalog entity.
NameStringTrueNoA human-friendly name associated to a catalog entity.
CreatedAtDatetimeTrueNoCreatedAt time.
UpdatedAtDatetimeTrueNoUpdatedAt time.
CatalogTypeStringTrueNoType of the catalog entity.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
CreativeAssetsIdStringTrueNoThe catalog creative assets id in the merchant namespace.
CatalogTypeStringTrueNoType of the catalog entity.
CatalogIdStringTrueNoCatalog id pertaining to the creative assets item. If not provided, default to oldest creative assets catalog.
CountryStringTrueNoCountry ID from ISO 3166-1 alpha-2.
LanguageStringTrueNoCatalog Language.
AttributesAdditionalImagelinkStringTrueNoThe links to additional images for your product.Must start with http:// or https://.
AttributesImageLinkStringTrueNoThe creative assets image.Must start with http:// or https://.
AttributesVideoLinkStringTrueNoThe creative assets video.
AttributesAdLinkStringTrueNoAllows 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://.
AttributesAdultBooleanTrueNoSet this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroupStringTrueNoThe age group to apply a demographic range to the product.
AttributesAvailabilityStringTrueNoThe availability of the product.
AttributesAverageReviewRatingIntegerTrueNoAverage reviews for the item. Can be a number from 1-5.
AttributesBrandStringTrueNoThe brand of the product.
AttributesColorStringTrueNoThe primary color of the product.
AttributesConditionStringTrueNoThe condition of the product.
AttributesCustomLabel0StringTrueNoCustom grouping of creative assets.
AttributesCustomLabel1StringTrueNoCustom grouping of creative assets.
AttributesCustomLabel2StringTrueNoCustom grouping of creative assets.
AttributesCustomLabel3StringTrueNoCustom grouping of creative assets.
AttributesCustomLabel4StringTrueNoCustom grouping of creative assets.
AttributesCustomNumber0LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescriptionStringTrueNoBrief description of the creative assets..
AttributesFreeShippingLabelBooleanTrueNoThe item is free to ship.
AttributesFreeShippingLimitStringTrueNoThe minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGenderStringTrueNoThe gender associated with the product.
AttributesGoogleProductCategoryStringTrueNoThe categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtinLongTrueNoThe unique universal product identifier.
AttributesItemGroupIdStringTrueNoThe parent ID of the product.
AttributesLastUpdatedTimeDatetimeTrueNoThe millisecond timestamp when the item was lastly modified by the merchant.
AttributesLinkStringTrueNoLink to the creative assets page.
AttributesMaterialStringTrueNoThe material used to make the product.
AttributesMinAdPriceStringTrueNoThe minimum advertised price of the product.
AttributesMobileLinkStringTrueNoThe mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpnStringTrueNoManufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatingsIntegerTrueNoThe number of ratings for the item.
AttributesNumberOfReviewsIntegerTrueNoThe number of reviews available for the item.
AttributesPatternStringTrueNoThe description of the pattern used for the product.
AttributesPriceStringTrueNoThe price of the product.
AttributesProductTypeStringTrueNoThe categorization of your product based on your custom product taxonomy.
AttributesSalePriceStringTrueNoThe discounted price of the product. The sale_price must be lower than the price.
AttributesShippingStringTrueNoShipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeightStringTrueNoThe height of the package needed to ship the product.
AttributesShippingWeightStringTrueNoThe weight of the product.
AttributesShippingWidthStringTrueNoThe width of the package needed to ship the product.
AttributesSizeStringTrueNoThe size of the product.
AttributesSizeSystemStringTrueNoIndicates the country’s sizing system in which you are submitting your product.
AttributesSizeTypeStringTrueNoAdditional description for the size.
AttributesTaxStringTrueNoTax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitleStringTrueNoThe name of the creative assets.
AttributesVariantNamesStringTrueNoOptions for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValuesStringTrueNoOption 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.
AttributesIosDeepLinkStringTrueNoIOS deep link to the creative assets page.
AttributesAndroidDeepLinkStringTrueNoLink to the creative assets page.
AttributesVisibilityStringTrueNoVisibility of the creative assets.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
HotelIdStringTrueNoThe catalog hotel id in the merchant namespace.
CatalogTypeStringTrueNoType of the catalog entity.
CatalogIdStringTrueNoCatalog id pertaining to the hotel item. If not provided, default to oldest hotel catalog.
CountryStringTrueNoCountry ID from ISO 3166-1 alpha-2.
LanguageStringTrueNoCatalog Language.
AttributesAdditionalImagelinkStringTrueNoThe 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://.
AttributesImageLinkStringTrueNoThe link to the main product images.Must start with http:// or https://.
AttributesVideoLinkStringTrueNoHosted link to the product video.
AttributesAdLinkStringTrueNoAllows 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://.
AttributesAdultBooleanTrueNoSet this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroupStringTrueNoThe age group to apply a demographic range to the product.
AttributesAvailabilityStringTrueNoThe availability of the product.
AttributesAverageReviewRatingIntegerTrueNoAverage reviews for the item. Can be a number from 1-5.
AttributesBrandStringTrueNoThe brand of the product.
AttributesColorStringTrueNoThe primary color of the product.
AttributesConditionStringTrueNoThe condition of the product.
AttributesCustomLabel0StringTrueNoCustom grouping of hotels.
AttributesCustomLabel1StringTrueNoCustom grouping of hotels.
AttributesCustomLabel2StringTrueNoCustom grouping of hotels.
AttributesCustomLabel3StringTrueNoCustom grouping of hotels.
AttributesCustomLabel4StringTrueNoCustom grouping of hotels.
AttributesCustomNumber0IntegerTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescriptionStringTrueNoBrief description of the hotel.
AttributesFreeShippingLabelBooleanTrueNoThe item is free to ship.
AttributesFreeShippingLimitStringTrueNoThe minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGenderStringTrueNoThe gender associated with the product.
AttributesGoogleProductCategoryStringTrueNoThe categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtinLongTrueNoThe unique universal product identifier.
AttributesItemGroupIdStringTrueNoThe parent ID of the product.
AttributesLastUpdatedTimeDatetimeTrueNoThe millisecond timestamp when the item was lastly modified by the merchant.
AttributesLinkStringTrueNoThe landing page for the product.
AttributesMaterialStringTrueNoThe material used to make the product.
AttributesMinAdPriceStringTrueNoThe minimum advertised price of the product.
AttributesMobileLinkStringTrueNoThe mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpnStringTrueNoManufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatingsIntegerTrueNoThe number of ratings for the item.
AttributesNumberOfReviewsIntegerTrueNoThe number of reviews available for the item.
AttributesPatternStringTrueNoThe description of the pattern used for the product.
AttributesPriceStringTrueNoThe price of the product.
AttributesProductTypeStringTrueNoThe categorization of your product based on your custom product taxonomy.
AttributesSalePriceStringTrueNoThe discounted price of the product. The sale_price must be lower than the price.
AttributesShippingStringTrueNoShipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeightStringTrueNoThe height of the package needed to ship the product.
AttributesShippingWeightStringTrueNoThe weight of the product.
AttributesShippingWidthStringTrueNoThe width of the package needed to ship the product.
AttributesSizeStringTrueNoThe size of the product.
AttributesSizeSystemStringTrueNoIndicates the country’s sizing system in which you are submitting your product.
AttributesSizeTypeStringTrueNoAdditional description for the size.
AttributesTaxStringTrueNoTax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitleStringTrueNoThe title of the product.
AttributesVariantNamesStringTrueNoOptions for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValuesStringTrueNoOption 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.
AttributesMainImageLinkStringTrueNoThe 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.
AttributesMainImageTagStringTrueNoTag appended to the image that identifies image category or details. There can be multiple tags associated with an image.
AttributesLatitudeIntegerTrueNoLatitude of the hotel.
AttributesLongitudeIntegerTrueNoLongitude of the hotel.
AttributesNeighborhoodStringTrueNoA list of neighborhoods where the hotel is located.
AttributesAddressAddr1StringTrueNoPrimary street address of hotel.
AttributesAddressCityStringTrueNoCity where the hotel is located.
AttributesAddressRegionStringTrueNoState, county, province, where the hotel is located.
AttributesAddressCountryStringTrueNoCountry where the hotel is located.
AttributesAddressPostalCodeStringTrueNoRequired for countries with a postal code system. Postal or zip code of the hotel.
AttributesCategoryStringTrueNoThe type of property. The category can be any type of internal description desired.
AttributesBasePriceStringTrueNoBase price of the hotel room per night followed by the ISO currency code.
AttributesGuestRatingsScoreIntegerTrueNoYour hotel's rating.
AttributesGuestRatingsNumberOfReviewersIntegerTrueNoTotal number of people who have rated this hotel.
AttributesGuestRatingsMaxScoreIntegerTrueNoMax value for the hotel rating score.
AttributesGuestRatingSystemStringTrueNoSystem you use for guest reviews.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
RetailItemIdStringTrueNoThe catalog retail item id in the merchant namespace.
CatalogTypeStringTrueNoType of the catalog entity.
CatalogIdStringTrueNoCatalog id pertaining to the retail item. If not provided, default to oldest retail catalog.
CountryStringTrueNoCountry ID from ISO 3166-1 alpha-2.
LanguageStringTrueNoCatalog Language.
AttributesAdditionalImagelinkStringTrueNoThe links to additional images for your product.Must start with http:// or https://.
AttributesImageLinkStringTrueNoThe link to the main product images.Must start with http:// or https://.
AttributesVideoLinkStringTrueNoHosted link to the product video.
AttributesAdLinkStringTrueNoAllows 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://.
AttributesAdultBooleanTrueNoSet this attribute to TRUE if you're submitting items that are considered “adult”. These will not be shown on Pinterest.
AttributesAgeGroupStringTrueNoThe age group to apply a demographic range to the product.
AttributesAvailabilityStringTrueNoThe availability of the product.
AttributesAverageReviewRatingIntegerTrueNoAverage reviews for the item. Can be a number from 1-5.
AttributesBrandStringTrueNoThe brand of the product.
AttributesColorStringTrueNoThe primary color of the product.
AttributesConditionStringTrueNoThe condition of the product.
AttributesCustomLabel0StringTrueNoCustom grouping of products.
AttributesCustomLabel1StringTrueNoCustom grouping of products.
AttributesCustomLabel2StringTrueNoCustom grouping of products.
AttributesCustomLabel3StringTrueNoCustom grouping of products.
AttributesCustomLabel4StringTrueNoCustom grouping of products.
AttributesCustomNumber0LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber1LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber2LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber3LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesCustomNumber4LongTrueNoAn attribute for any integer information ranging from 0 to 4,294,967,295, which can be used to group items.
AttributesDescriptionStringTrueNoThe description of the product.
AttributesFreeShippingLabelBooleanTrueNoThe item is free to ship.
AttributesFreeShippingLimitStringTrueNoThe minimum order purchase necessary for the customer to get free shipping.Only relevant if free shipping is offered.
AttributesGenderStringTrueNoThe gender associated with the product.
AttributesGoogleProductCategoryStringTrueNoThe categorization of the product based on the standardized Google Product Taxonomy.
AttributesGtinLongTrueNoThe unique universal product identifier.
AttributesItemGroupIdStringTrueNoThe parent ID of the product.
AttributesLastUpdatedTimeDatetimeTrueNoThe millisecond timestamp when the item was lastly modified by the merchant.
AttributesLinkStringTrueNoThe landing page for the product.
AttributesMaterialStringTrueNoThe material used to make the product.
AttributesMinAdPriceStringTrueNoThe minimum advertised price of the product.
AttributesMobileLinkStringTrueNoThe mobile-optimized version of your landing page. Must begin with http:// or https://.
AttributesMpnStringTrueNoManufacturer Part Number are alpha-numeric codes created by the manufacturer of a product to uniquely identify it among all products from the same manufacturer.
AttributesNumberOfRatingsIntegerTrueNoThe number of ratings for the item.
AttributesNumberOfReviewsIntegerTrueNoThe number of reviews available for the item.
AttributesPatternStringTrueNoThe description of the pattern used for the product.
AttributesPriceStringTrueNoThe price of the product.
AttributesProductTypeStringTrueNoThe categorization of your product based on your custom product taxonomy.
AttributesSalePriceStringTrueNoThe discounted price of the product. The sale_price must be lower than the price.
AttributesShippingStringTrueNoShipping consists of one group of up to four elements, country, region, service (all optional) and price (required).
AttributesShippingHeightStringTrueNoThe height of the package needed to ship the product.
AttributesShippingWeightStringTrueNoThe weight of the product.
AttributesShippingWidthStringTrueNoThe width of the package needed to ship the product.
AttributesSizeStringTrueNoThe size of the product.
AttributesSizeSystemStringTrueNoIndicates the country’s sizing system in which you are submitting your product.
AttributesSizeTypeStringTrueNoAdditional description for the size.
AttributesTaxStringTrueNoTax consists of one group of up to four elements, country, region, rate (all required) and tax_ship (optional).
AttributesTitleStringTrueNoThe name of the product.
AttributesVariantNamesStringTrueNoOptions for this variant. People will see these options next to your Pin and can select the one they want.
AttributesVariantValuesStringTrueNoOption 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.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIDStringTrueAdAccounts.IdNoAssociated ad account ID.
IdStringTrueNoCustomer list ID.
NameStringTrueNoCustomer list name.
CreatedTimeDatetimeTrueNoCreation time. Unix timestamp in seconds.
UpdatedTimeDatetimeTrueNoLast update time. Unix timestamp in seconds.
NumBatchesIntegerTrueNoTotal number of list updates.
NumRemovedUserRecordsIntegerTrueNoNumber of removed user records.
NumUploadedUserRecordsIntegerTrueNoNumber of uploaded user records.
StatusStringTrueNoCustomer list status. TOO_SMALL - the list has less than 100 Pinterest users.
TypeStringTrueNoAlways customerlist
OrderStringFalseYesThe order in which to sort the items returned: ASCENDING or DESCENDING by ID.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoFeed Processing Result ID.
FeedIdStringTrueFeeds.IdNoUnique identifier of a feed.
CreatedAtDatetimeTrueNoCreatedAt time.
UpdatedAtDatetimeTrueNoUpdatedAt time.
ProductCountsOriginalIntegerTrueNoThe number of products in the feed file.
ProductCountsIngestedIntegerTrueNoThe number of products successfully ingested from the feed file.
StatusStringTrueNoStatus.
IngestionErrorLineLevelInternalErrorIntegerTrueNoWe experienced a technical difficulty and were unable to ingest this some items. The next ingestion will happen in 24 hours.
IngestionErrorLargeProductCountDecreaseIntegerTrueNoThe product count has decreased by more than 99% compared to the last successful ingestion.
IngestionErrorAccountFlaggedIntegerTrueNoWe detected an issue with your account and are not currently ingesting your items.
IngestionErrorImageLevelInternalErrorIntegerTrueNoWe experienced a technical difficulty and were unable to download some images. The next download attempt will happen in 24 hours.
IngestionErrorImageFileNotAccessibleIntegerTrueNoImage files are unreadable. Please upload new files to continue.
IngestionErrorImageMalformedUrlIntegerTrueNoImage files are unreadable. Please check your link and upload new files to continue.
IngestionErrorImageFileNotFoundIntegerTrueNoImage files are unreadable. Please upload new files to continue.
IngestionErrorImageInvalidFileIntegerTrueNoImage files are unreadable. Please upload new files to continue.
IngestionErrorFetchGoogleSheetNotSharedIntegerTrueNoUpdate your Google Sheets sharing settings to 'Anyone with link' as a Viewer so that Pinterest can access your file.
IngestionInfoInStockIntegerTrueNoThe number of ingested products that are in stock.
IngestionInfoOutOfStockIntegerTrueNoThe number of ingested products that are in out of stock.
IngestionInfoPreorderIntegerTrueNoThe number of ingested products that are in preorder.
IngestionWarningAdditionalImageLevelInternalErrorIntegerTrueNoWe experienced a technical difficulty and were unable to download some additional images. The next download attempt will happen in 24 hours.
IngestionWarningAdditionalImageFileNotAccessibleIntegerTrueNoAdditional image files are unreadable. Please upload new files to continue.
IngestionWarningAdditionalImageMalformedUrlIntegerTrueNoAdditional image files are unreadable. Please check your link and upload new files to continue.
IngestionWarningAdditionalImageFileNotFoundIntegerTrueNoAdditional image files are unreadable. Please upload new files to continue.
IngestionWarningAdditionalImageInvalidFileIntegerTrueNoAdditional image files are unreadable. Please upload new files to continue.
IngestionWarningHotelPriceHeaderIsPresentIntegerTrueNoprice is not a supported column. Use base_price and sale_price instead.
IngestionWarningFetchGoogleSheetPublicCanEditIntegerTrueNoUpdate your Google Sheets sharing settings from 'Editor' to 'Viewer'.
ValidationErrorFetchErrorIntegerTrueNoPinterest couldn't download your feed.
ValidationErrorFetchInactiveFeedErrorIntegerTrueNoYour feed wasn't ingested because it hasn’t changed in the previous 90 days.
ValidationErrorEncodingErrorIntegerTrueNoYour feed includes data with an unsupported encoding format.
ValidationErrorDelimiterErrorIntegerTrueNoYour feed includes data with formatting errors.
ValidationErrorRequiredColumnsMissingIntegerTrueNoYour feed is missing some required column headers.
ValidationErrorDuplicateProductsIntegerTrueNoSome products are duplicated.
ValidationErrorImageLinkInvalidIntegerTrueNoSome image links are formatted incorrectly.
ValidationErrorItemIdMissingIntegerTrueNoSome items are missing an item id in their product metadata, those items will not be published.
ValidationErrorTitleMissingIntegerTrueNoSome items are missing a title in their product metadata, those items will not be published.
ValidationErrorDescriptionMissingIntegerTrueNoSome items are missing a description in their product metadata, those items will not be published.
ValidationErrorProductLinkMissingIntegerTrueNoSome items are missing a link URL in their product metadata, those items will not be published.
ValidationErrorImageLinkMissingIntegerTrueNoSome items are missing an image link URL in their product metadata, those items will not be published.
ValidationErrorAvailabilityInvalidIntegerTrueNoSome items are missing an availability value in their product metadata, those items will not be published.
ValidationErrorProductPriceInvalidIntegerTrueNoSome items have price formatting errors in their product metadata, those items will not be published.
ValidationErrorLinkFormatInvalidIntegerTrueNoSome link values are formatted incorrectly.
ValidationErrorParseLineErrorIntegerTrueNoYour feed contains formatting errors for some items.
ValidationErrorAdwordsFormatInvalidIntegerTrueNoSome adwords links contain too many characters.
ValidationErrorInternalServiceErrorIntegerTrueNoWe experienced a technical difficulty and were unable to ingest your feed. The next ingestion will happen in 24 hours.
ValidationErrorNoVerifiedDomainIntegerTrueNoYour merchant domain needs to be claimed.
ValidationErrorAdultInvalidIntegerTrueNoSome items have invalid adult values.
ValidationErrorImageLinkLengthTooLongIntegerTrueNoSome items have image_link URLs that contain too many characters, so those items will not be published.
ValidationErrorInvalidDomainIntegerTrueNoSome of your product link values don't match the verified domain associated with this account.
ValidationErrorFeedLengthTooLongIntegerTrueNoYour feed contains too many items, some items will not be published.
ValidationErrorLinkLengthTooLongIntegerTrueNoSome product links contain too many characters, those items will not be published.
ValidationErrorMalformedXmlIntegerTrueNoYour feed couldn't be validated because the xml file is formatted incorrectly.
ValidationErrorPriceMissingIntegerTrueNoSome products are missing a price, those items will not be published.
ValidationErrorFeedTooSmallIntegerTrueNoYour feed couldn't be validated because the file doesn't contain the minimum number of lines required.
ValidationErrorMaxItemsPerItemGroupExceededIntegerTrueNoSome items exceed the maximum number of items per item group, those items will not be published.
ValidationErrorItemMainImageDownloadFailureIntegerTrueNoSome items' main images can't be found.
ValidationErrorPinJoinContentUnsafeIntegerTrueNoSome items were not published because they don't meet Pinterest's Merchant Guidelines.
ValidationErrorBlocklistedImageSignatureIntegerTrueNoSome items were not published because they don't meet Pinterest's Merchant Guidelines.
ValidationErrorListPriceInvalidIntegerTrueNoSome items have list price formatting errors in their product metadata, those items will not be published.
ValidationErrorPriceCannotBeDeterminedIntegerTrueNoSome 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.
ValidationWarningAdLinkFormatWarningIntegerTrueNoSome items have ad links that are formatted incorrectly.
ValidationWarningAdLinkSameAsLinkIntegerTrueNoSome items have ad link URLs that are duplicates of the link URLs for those items.
ValidationWarningTitleLengthTooLongIntegerTrueNoThe title for some items were truncated because they contain too many characters.
ValidationWarningDescriptionLengthTooLongIntegerTrueNoThe description for some items were truncated because they contain too many characters.
ValidationWarningGenderInvalidIntegerTrueNoSome items have gender values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningAgeGroupInvalidIntegerTrueNoSome items have age group values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningSizeTypeInvalidIntegerTrueNoSome items have size type values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningSizeSystemInvalidIntegerTrueNoSome items have size system values which are not one of the supported size systems.
ValidationWarningLinkFormatWarningIntegerTrueNoSome items have an invalid product link which contains invalid UTM tracking paramaters.
ValidationWarningSalesPriceInvalidIntegerTrueNoSome items have sale price values that are higher than the original price of the item.
ValidationWarningProductCategoryDepthWarningIntegerTrueNoSome items only have 1 or 2 levels of google_product_category values, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningAdwordsFormatWarningIntegerTrueNoSome items have adwords_redirect links that are formatted incorrectly.
ValidationWarningAdwordsSameAsLinkIntegerTrueNoSome items have adwords_redirect URLs that are duplicates of the link URLs for those items.
ValidationWarningDuplicateHeadersIntegerTrueNoYour feed contains duplicate headers.
ValidationWarningFetchSameSignatureIntegerTrueNoIngestion completed early because there are no changes to your feed since the last successful update.
ValidationWarningAdditionalImageLinkLengthTooLongIntegerTrueNoSome items have additional_image_link URLs that contain too many characters, so those items will not be published.
ValidationWarningAdditionalImageLinkWarningIntegerTrueNoSome items have additional_image_link URLs that are formatted incorrectly and will not be published with your items.
ValidationWarningImageLinkWarningIntegerTrueNoSome items have image_link URLs that are formatted incorrectly and will not be published with those items.
ValidationWarningShippingInvalidIntegerTrueNoSome items have shipping values that are formatted incorrectly.
ValidationWarningTaxInvalidIntegerTrueNoSome items have tax values that are formatted incorrectly.
ValidationWarningShippingWeightInvalidIntegerTrueNoSome items have invalid shipping_weight values.
ValidationWarningExpirationDateInvalidIntegerTrueNoSome items have expiration_date values that are formatted incorrectly, those items will be published without an expiration date.
ValidationWarningAvailabilityDateInvalidIntegerTrueNoSome items have availability_date values that are formatted incorrectly, those items will be published without an availability date.
ValidationWarningSaleDateInvalidIntegerTrueNoSome items have sale_price_effective_date values that are formatted incorrectly, those items will be published without a sale date.
ValidationWarningWeightUnitInvalidIntegerTrueNoSome items have weight_unit values that are formatted incorrectly, those items will be published without a weight unit.
ValidationWarningIsBundleInvalidIntegerTrueNoSome items have is_bundle values that are formatted incorrectly, those items will be published without being bundled with other products.
ValidationWarningUpdatedTimeInvalidIntegerTrueNoSome items have updated_time values thate are formatted incorrectly, those items will be published without an updated time.
ValidationWarningCustomLabelLengthTooLongIntegerTrueNoSome items have custom_label values that are too long, those items will be published without that custom label.
ValidationWarningProductTypeLengthTooLongIntegerTrueNoSome items have product_type values that are too long, those items will be published without that product type.
ValidationWarningTooManyAdditionalImageLinksIntegerTrueNoSome items have additional_image_link values that exceed the limit for additional images, those items will be published without some of your images.
ValidationWarningMultipackInvalidIntegerTrueNoSome items have invalid multipack values.
ValidationWarningIndexedProductCountLargeDeltaIntegerTrueNoThe product count has increased or decreased significantly compared to the last successful ingestion.
ValidationWarningItemAdditionalImageDownloadFailureIntegerTrueNoSome items include additional_image_links that can't be found.
ValidationWarningOptionalProductCategoryMissingIntegerTrueNoSome items are missing a google_product_category.
ValidationWarningOptionalProductCategoryInvalidIntegerTrueNoSome items include google_product_category values that are not formatted correctly according to the GPC taxonomy.
ValidationWarningOptionalConditionMissingIntegerTrueNoSome items are missing a condition value, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningOptionalConditionInvalidIntegerTrueNoSome items include condition values that are formatted incorrectly, which may limit visibility in recommendations, search results and shopping experiences.
ValidationWarningIosDeepLinkInvalidIntegerTrueNoSome items include invalid ios_deep_link values.
ValidationWarningAndroidDeepLinkInvalidIntegerTrueNoSome items include invalid android_deep_link.
ValidationWarningUtmSourceAutoCorrectedIntegerTrueNoSome items include utm_source values that are formatted incorrectly and have been automatically corrected.
ValidationWarningCountryDoesNotMapToCurrencyIntegerTrueNoSome items include a currency that doesn't match the usual currency for the location where that product is sold or shipped.
ValidationWarningMinAdPriceInvalidIntegerTrueNoSome items include min_ad_price values that are formatted incorrectly.
ValidationWarningGtinInvalidIntegerTrueNoSome items include incorrectly formatted GTINs.
ValidationWarningInconsistentCurrencyValuesIntegerTrueNoSome items include inconsistent currencies in price fields.
ValidationWarningSalesPriceTooLowIntegerTrueNoSome items include sales price that is much lower than the list price.
ValidationWarningShippingWidthInvalidIntegerTrueNoSome items include incorrectly formatted shipping_width.
ValidationWarningShippingHeightInvalidIntegerTrueNoSome items include incorrectly formatted shipping_height.
ValidationWarningSalesPriceTooHighIntegerTrueNoSome items include a sales price that is higher than the list price. The sales price has been defaulted to the list price.
ValidationWarningMpnInvalidIntegerTrueNoSome items include incorrectly formatted MPNs.
AdAccountIdStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID of the feed.
NameStringTrueNoA human-friendly name associated to a given feed.
CreatedAtDatetimeTrueNoCreatedAt time.
UpdatedAtDatetimeTrueNoUpdatedAt time.
CatalogTypeStringTrueNoType of the catalog entity.
FormatStringTrueNoThe file format of a feed.
LocationStringTrueNoThe URL where a feed is available for download. This URL is what Pinterest will use to download a feed for processing.
StatusStringTrueNoStatus for catalogs entities. Present in catalogs_feed values. When a feed is deleted,the response will inform DELETED as status.
DefaultCurrencyStringTrueNoCurrency Codes from ISO 4217.
DefaultLocaleStringTrueNoThe locale used within a feed for product descriptions.
DefaultCountryStringTrueNoCountry ID from ISO 3166-1 alpha-2.
DefaultAvailabilityStringTrueNoDefault availability for products in a feed.
CredentialsUsernameStringTrueNoThe required username for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password.
CredentialsPasswordStringTrueNoThe required password for downloading a feed. This field is OPTIONAL. Use this if your feed file requires username and password.
PreferredProcessingScheduleTimeStringTrueNoA time in format HH with leading 0 (zero). This field is OPTIONAL. Use this to configure the preferred time for processing a feed.
PreferredProcessingScheduleTimezoneStringTrueNoThe timezone considered for the processing schedule time. This field is OPTIONAL.Use this to configure the preferred time for processing a feed.
AdAccountIdStringFalseYesUnique identifier of an ad account.
CatalogIdStringFalseYesFilter entities for a given catalog_id. If not given, all catalogs are considered.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Username [KEY]StringTrueNoUsername
TypeStringTrueNoAlways user

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Username [KEY]StringTrueNoUsername
TypeStringTrueNoAlways user
FeedTypeStringFalseYesSpecifies the type of followees to be kept when filtering them. Default - ALL
ExplicitFollowingBooleanFalseYesWhether or not to include implicit user follows, which means followees with board follows.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID
NameStringTrueNoName
DescriptionStringTrueNoDescription
CreatedAtDatetimeTrueNoDate and time of board creation.
BoardPinsModifiedAtDatetimeTrueNoDate and time of last board pins modified.
CollaboratorCountIntegerTrueNoCount of collaborators on the board.
PinCountIntegerTrueNoCount of pins on the board.
FollowerCountIntegerTrueNoBoard follower count.
MediaImageCoverUrlStringTrueNoBoard cover image.
MediaPinThumbnailUrlsStringTrueNoBoard pin thumbnail urls.
OwnerUsernameStringTrueNoOwner Username.
PrivacyStringTrueNoPrivacy setting for a board.Default - PUBLIC
ExplicitFollowingBooleanFalseYesWhether or not to include implicit user follows, which means followees with board follows.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
UsernameStringTrueNoA valid username.
IdStringTrueNoID.
KeyStringTrueNoKey.
NameStringTrueNoName.
CanonicalUrlStringTrueNoCanonical Url.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Username [KEY]StringTrueNoA valid username.
ImageSmallUrlStringTrueNoImage Small Url.
ImageMediumUrlStringTrueNoImage Medium Url.
ImageLargeUrlStringTrueNoImage Large Url.
ImageXLargeUrlStringTrueNoImage XLarge Url.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoId of the Pin
BoardIdStringTrueBoards.IdNoId of the Board
SectionIdStringTrueBoardSections.IdNoId of the Section
AltTextStringTrueNoAltText
BoardOwnerUsernameStringTrueNoUserName of the BoardOwner.
CreatedAtDatetimeTrueNoCreated At Date Time
DescriptionStringTrueNoDescription of the Pin.
LinkStringTrueNoLink to the Pin.
MediaTypeStringTrueNoMediaType of the Pin.
MediaStringTrueNoMedia for the Pin.
TitleStringTrueNoTitle of the Pin.
PinMetricsStringTrueNoPin metrics of the Pin.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AdAccountIdStringTrueAdAccounts.IdNoUnique identifier of an ad account.
ProductGroupIdStringTrueNoProduct group Ids .
TargetingTypeStringTrueNoTargeting type.
TargetingValuesStringTrueNoTargeting type value.
DateDateTrueNoDate the analytics row covers.
SpendInDollarDecimalTrueNoTotal spend in dollars.
AdvertiserIdDoubleTrueNoId of the advertiser.
AdGroupEntityStatusDoubleTrueNoId of the advertiser.
AdIdDoubleTrueNoId of the advertiser.
CampaignIdStringTrueCampaigns.IdNoId of the Campaign.
CampaignDailySpendCapStringTrueNoCampaign daily spend cap.
CampaignEntityStatusStringTrueNoCampaign entity status.
CampaignLifetimeSpendCapIntegerTrueNoCampaign Lifetime Spend Cap.
CtrDoubleTrueNoCtr.
Ctr2DoubleTrueNoCtr2.
CheckoutRoasDoubleTrueNoCheckout roas.
Clickthrough1IntegerTrueNoClickthrough1.
Clickthrough2IntegerTrueNoClickthrough2.
Clickthrough1GrossIntegerTrueNoClickthrough1 Gross.
CpcInMicroDollarDecimalTrueNoCpc In MicroDollar.
CpmInMicroDollarDecimalTrueNoCpm In MicroDollar.
EctrDecimalTrueNoEctr.
EcpeInDollarDecimalTrueNoEcpe in Dollars.
EngagementRateDoubleTrueNoThe engagement rate.
EengagementRateDoubleTrueNoE Engagement rate.
EcpvInDollarDecimalTrueNoEcpv in dollars.
EcpcvInDollarDecimalTrueNoE Cpcv in Dollars.
EcpcvP95InDollarDecimalTrueNoE Cpcv 95 percent in Dollars.
EcpcInMicroDollarDecimalTrueNoEcpc In MicroDollar.
EcpmInMicroDollarDecimalTrueNoEcpm In MicroDollar.
Engagement1IntegerTrueNoEngagement1.
Engagement2IntegerTrueNoEngagement2.
Impression1IntegerTrueNoImpression1.
Impression1GrossIntegerTrueNoImpression1 Gross.
Impression2IntegerTrueNoImpression2.
IdeaPinProductTagVisit1IntegerTrueNoIdea Pin Product Tag Visit1.
IdeaPinProductTagVisit2IntegerTrueNoIdea Pin Product Tag Visit2.
InAppCheckoutCostPerActionDoubleTrueNoIn App Checkout Cost Per Action.
OutboundClick1IntegerTrueNoOutboundclick1.
OutboundClick2IntegerTrueNoOutboundclick2.
PinIdStringTruePins.IdNoId of the Pins.
PageVisitCostPerActionDoubleTrueNoPage visit cost per action.
PageVisitRoasDoubleTrueNoPage visit roas.
PaidImpressionIntegerTrueNoPaidImpression.
Repin1IntegerTrueNoRepin1.
Repin2IntegerTrueNoRepin2.
RepinRateDoubleTrueNoThe repin rate.
TotalClickthroughIntegerTrueNoTotal Clickthrough.
TotalEngagementSignupIntegerTrueNoTotal Engagement Signup.
TotalEngagementCheckoutIntegerTrueNoTotal Engagement Checkout.
TotalClickSignupIntegerTrueNoTotal Click Signup.
TotalClickCheckoutIntegerTrueNoTotal Click Checkout.
TotalViewSignupIntegerTrueNoTotal View Signup.
TotalViewCheckoutIntegerTrueNoTotal View Checkout.
TotalConversionsIntegerTrueNoTotal Conversions.
TotalEngagementSignupValueInMicroDollarDecimalTrueNoTotal Engagement Signup Value In Micro Dollar.
TotalEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Engagement Checkout Value In Micro Dollar.
TotalClickSignupValueInMicroDollarDecimalTrueNoTotal Click Signup Value In Micro Dollar.
TotalClickCheckoutValueInMicroDollarDecimalTrueNoTotal Click Checkout Value In Micro Dollar.
TotalViewSignupValueInMicroDollarDecimalTrueNoTotal View Signup Value In Micro Dollar.
TotalViewCheckoutValueInMicroDollarDecimalTrueNoTotal View Checkout Value In Micro Dollar.
TotalPageVisitIntegerTrueNoTotal Page Visit.
TotalSignupIntegerTrueNoTotal Signup.
TotalCheckoutIntegerTrueNoTotal Checkout.
TotalSignupValueInMicroDollarDecimalTrueNoTotal Signup Value In Micro Dollar.
TotalCheckoutValueInMicroDollarDecimalTrueNoTotal Checkout Value In Micro Dollar.
TotalVideo3secViewsIntegerTrueNoTotal Video 3 second Views.
TotalVideoP100CompleteIntegerTrueNoTotal Video 100 percent Complete.
TotalVideoP0CombinedIntegerTrueNoTotal Video 0 percent Combined.
TotalVideoP25CombinedIntegerTrueNoTotal Video 25 percent Combined.
TotalVideoP50CombinedIntegerTrueNoTotal Video 50 percent Combined.
TotalVideoP75CombinedIntegerTrueNoTotal Video 75 percent Combined.
TotalVideoP95CombinedIntegerTrueNoTotal Video 95 percent Combined.
TotalVideoMrcViewsIntegerTrueNoTotal Video Mrc Views.
TotalVideoAvgWatchtimeInSecondIntegerTrueNoTotal Video Avg Watchtime In Seconds.
TotalRepinRateDoubleTrueNoTotal Repin Rate.
TotalWebCheckoutIntegerTrueNoTotal Web Checkout.
TotalWebCheckoutValueInMicroDollarDecimalTrueNoTotal Web Checkout Value In Micro Dollar.
TotalWebClickCheckoutIntegerTrueNoTotal Web Click Checkout.
TotalWebClickCheckoutValueInMicroDollarDecimalTrueNoTotal Web Click Checkout Value In Micro Dollar.
TotalWebEngagementCheckoutIntegerTrueNoTotal Web Engagement Checkout.
TotalWebEngagementCheckoutValueInMicroDollarDecimalTrueNoTotal Web Engagement Checkout Value In Micro Dollar.
TotalWebViewCheckoutIntegerTrueNoTotal Web View Checkout.
TotalWebViewCheckoutValueInMicroDollarDecimalTrueNoTotal Web View Checkout Value In Micro Dollar.
Video3secViews2IntegerTrueNoVideo 3 second Views.
VideoLengthIntegerTrueNoVideoLength.
VideoMrcViews2IntegerTrueNoVideo 2 second Views.
VideoP0Combined2IntegerTrueNoVideo 0 percent Combined Views.
VideoP100Complete2IntegerTrueNoVideo 100 percent Complete Views.
VideoP25Combined2IntegerTrueNoVideo 25 percent Complete Views.
VideoP50Combined2IntegerTrueNoVideo 50 percent Complete Views.
VideoP75Combined2IntegerTrueNoVideo 75 percent Complete Views.
VideoP95Combined2IntegerTrueNoVideo 95 percent Complete Views.
WebCheckoutCostPerActionDoubleTrueNoWeb checkout cost per action.
WebCheckoutRoasDoubleTrueNoWeb checkout roas.
WebSessions1IntegerTrueNoWebSessions1.
WebSessions2IntegerTrueNoWebSessions2.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
GranularityStringTrueNoGranularity.
AttributionTypesStringFalseYesList of types of attribution for the conversion report.
ClickWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a pin click action.
EngagementWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for an engagement action.
ViewWindowDaysIntegerFalseYesNumber of days to use as the conversion attribution window for a view action.
ConversionReportTimeIntegerFalseYesThe date by which the conversion metrics returned from this endpoint will be reported.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AgeBucketKeyStringTrueNoIt contains the key of the age bucket.
AgeBucketValueStringTrueNoIt contains the value of the age bucket.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AppKeyStringTrueNoIt contains the key of the apptype.
AppValueStringTrueNoIt contains the value of the apptype.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AudienceExcludeKeyStringTrueNoIt contains the key of the Audience Exclude metric.
AudienceExcludeValueStringTrueNoIt contains the value of the Audience Exclude metric.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AudienceIncludeKeyStringTrueNoIt contains the key of the Audience Include metric.
AudienceIncludeValueStringTrueNoIt contains the value of the Audience Include metric.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
GenderKeyStringTrueNoIt contains the key of the gender.
GenderValueStringTrueNoIt contains the value of the gender.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
GeoKeyStringTrueNoIt contains the key of the Geo.
GeoValueStringTrueNoIt contains the value of the Geo.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
InterestIdStringTrueNoIt contains the id of the interest.
InterestLevelStringTrueNoIt contains the level of the interest.
InterestNameStringTrueNoIt contains the name of the interest.
InterestAggregateStringTrueNoIt contains the data inside the particular level of the interest.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
KeywordKeyStringTrueNoIt contains the key of the keyword.
KeywordValueStringTrueNoIt contains the value of the keyword.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
LocaleKeyStringTrueNoIt contains the key of the locale
LocaleValueStringTrueNoIt contains the value of the locale

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
LocationKeyStringTrueNoIt contains the key of the Location
LocationValueStringTrueNoIt contains the value of the Location

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
AccountTypeStringTrueNoType of account.
ProfileImageStringTrueNoProfile Image.
UsernameStringTrueNoUsername.
WebsiteURLStringTrueNoWebsite URL.
BoardCountIntegerTrueNoBoard count.
PinCountIntegerTrueNoPin count.
FollowerCountIntegerTrueNoFollower count.
FollowingCountIntegerTrueNoFollowing count.
AdAccountIDStringFalseYesSpecify an ad_account_id to use the owner of that ad_account as the operation user_account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OutboundClickIntegerTrueNoTotal outbound click.
OutboundClickRateDecimalTrueNoOutbound Click Rate.
EngagementIntegerTrueNoTotal engagements.
EngagementRateDecimalTrueNoEngagement Rate.
PinClickIntegerTrueNoTotal pin clicks.
PinClickRateDecimalTrueNoPin Click Rate.
ImpressionIntegerTrueNoTotal impressions.
SaveIntegerTrueNoTotal saves.
SaveRateDecimalTrueNoSave Rate.
DataStatusStringTrueNoMetrics Availablity.
DateDateTrueNoMetrics Date.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
FromClaimedContentStringFalseYesFilter on Pins that match your claimed domain.
PinFormatStringFalseYesPin formats to get data for, default is all.
AppTypesStringFalseYesApps or devices to get data for, default is all.
MetricTypesStringFalseYesMetric types to get data for, default is all.
SplitFieldStringFalseYesHow to split the data into groups. Not including this param means data won't be split.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
OutboundClickIntegerTrueNoTotal outbound click.
OutboundClickRateDecimalTrueNoOutbound Click Rate.
EngagementIntegerTrueNoTotal engagements.
EngagementRateDecimalTrueNoEngagement Rate.
PinClickIntegerTrueNoTotal pin clicks.
PinClickRateDecimalTrueNoPin Click Rate.
ImpressionIntegerTrueNoTotal impressions.
SaveIntegerTrueNoTotal saves.
SaveRateDecimalTrueNoSave Rate.
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
FromClaimedContentStringFalseYesFilter on Pins that match your claimed domain.
PinFormatStringFalseYesPin formats to get data for, default is all.
AppTypesStringFalseYesApps or devices to get data for, default is all.
MetricTypesStringFalseYesMetric types to get data for, default is all.
SplitFieldStringFalseYesHow to split the data into groups. Not including this param means data won't be split.
AdAccountIDStringFalseYesUnique identifier of an ad account.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
SortByStringFalseNoSpecify sorting order for metrics.
ImpressionIntegerTrueNoImpression.
SaveIntegerTrueNoSave.
VideoMrcViewIntegerTrueNoVideo second Views.
VideoAvgWatchTimeIntegerTrueNoVideo second Views.
VideoV50WatchTimeIntegerTrueNoVideo 50 Seond Views.
Quartile95PercentViewIntegerTrueNoVideo 95 percent Views.
Video10SViewIntegerTrueNoVideo 10 second Views.
VideoStartIntegerTrueNoVIDEO_START.
OutboundClickIntegerTrueNoOutboundclick.
CreatedInLastNDaysIntegerFalseYesGet metrics for pins created in the last
NumOfPinsIntegerFalseYesNumber of pins to include, default is 10. Max is 50.
MetricTypesStringFalseYesMetric types to get data for, default is all.
AppTypeStringFalseYesApps or devices to get data for, default is all.
PinFormatStringFalseYesPin formats to get data for, default is all.
FromClaimedContentStringFalseYesFilter on Pins that match your claimed domain.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
StartDateDateTrueNoMetric report start date.
EndDateDateTrueNoMetric report end date.
SortByStringTrueNoSpecify sorting order for metrics.
EngagementIntegerTrueNoEngagement.
EngagementRateDoubleTrueNoThe engagement rate.
ImpressionIntegerTrueNoImpression.
OutboundClickIntegerTrueNoOutboundclick.
OutboundClickRateIntegerTrueNoOUTBOUNDCLICKRATE.
PinClickIntegerTrueNoPINCLICK.
PinClickRateIntegerTrueNoPINCLICKRate.
SaveIntegerTrueNoSave.
SaveRateIntegerTrueNoSAVE RATE.
CreatedInLastNDaysIntegerFalseYesGet metrics for pins created in the last
NumOfPinsIntegerFalseYesNumber of pins to include, default is 10. Max is 50.
MetricTypesStringFalseYesMetric types to get data for, default is all.
AppTypeStringFalseYesApps or devices to get data for, default is all.
PinFormatStringFalseYesPin formats to get data for, default is all.
FromClaimedContentStringFalseYesFilter on Pins that match your claimed domain.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
VerificationCodeStringTrueNoCode to check against the user claiming the website.
DnsTxtRecordStringTrueNoDNS TXT record to check against for the website to be claimed.
MetatagStringTrueNoMetatag the verification process searchs for the website to be claimed.
FilenameStringTrueNoFile expected to find on the website being claimed.
FileContentStringTrueNoA full html file to upload to the website in order for it to be claimed.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
WebsiteStringTrueNoWebsite with path or domain only
StatusStringTrueNoStatus of the verification process.
VerifiedAtDatetimeTrueNoUTC timestamp when the verification happened - sometimes missing.

Return to Top