GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
These docs are for v2022.07. Click to read the latest docs for v2024.04.

Metrics and Dimensions

Report Metrics

  • Most metrics are available for every report type, with some exceptions to assistedSales and assistedUnits which apply only to Line Item reports

  • Attributed Transactions report only has two metrics: attributedSales and attributedUnits

MetricDescription
impressionsReport Types: Campaign reports

Description: Measured when an ad creative renders on a page; an ad creative may display products from one or more campaigns; each unique campaign is counted once; used in all report types except for Product and Product Category reports

Report Types: Line Item reports

Description: Measured when an ad creative renders on a page; an ad creative may display products from one or more line items; each unique line item is counted once; used in all report types except for Product and Product Category reports

Report Types: Product and Product Category

Description: Measured when a promoted product is rendered on the page, whether as a single ad creative or as one of many products in an ad creative; each product is counted once separately
clicksMeasured when an ad creative is clicked on, which incurs a cost to the advertiser for open auction campaigns
spendFor open auctions campaigns, the total cost of clicks for the advertiser; inclusive of platform fees
attributedSalesSales revenue attributed to a click or impression; exclusive of assistedSales
attributedUnitsUnits sold attributed to a click or impression; exclusive of assistedUnits
attributedOrdersOrders (or transactions) attributed to a click or impression
ctrClick-through-rate (CTR), calculated by dividing clicks by productImpressions for Product and Product Category report types; for all other report types, the appropriate placementImpressions is used instead
cpcCost-per-click (CPC), calculated by dividing spend by clicks; inclusive of platform fees
roasReturn-on-ad-spend (ROAS), calculated by dividing attributedSales by spend; inclusive of platform fees
cpoCost-per-order (CPO), calculated by dividing spend by attributedOrders; inclusive of platform fees
assistedSalesSales revenue attributed to a click or impression on the path to purchase leading to the sale; exclusive of attributedSales

Report Types : Line Item reports only
assistedUnitsUnits sold attributed to a click or impression on the path to purchase leading to the sale; attributedUnits

Report Types : Line Item reports only
uniqueVisitorsNumber of unique visitors an impression painted for

Report Types : Campaign, Line Item and Summary reports only
frequencyAn average representing how often an impression has painted for the same user

Report Types : Campaign, Line Item and Summary reports only

Report Dimensions

  • Available dimensions vary by report type

  • The Attributed Transactions report is documented separately below

DimensionDescription
dateDate based on the requested time zone
campaignIdCampaign ID of the requested report
campaignNameCampaign name of the request report
campaignTypeNameType of campaign configured
lineItemIdLine item ID of the requested report

Report Types : Line Item reports only
lineItemNameLine item name of the requested report

Report Types : Line Item reports only
retailerIdRetailer ID of the retailer the line item served on

Report Types : Line Item reports only
retailerNameRetailer name of the retailer the line item served on

Report Types : Line Item reports only
pageTypeNameType of retailer web page an ad creative rendered on, such as home page, browse pages, search pages, product detail pages, checkout pages etc.

Report Types : Page Type reports only
keywordKeyword or phrase used to land on the search page where an ad creative rendered


Report Types : Keyword reports only
advProductCategoryCategory of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories

Report Types : Product & Product Category reports only
advProductIdAdvertised product ID; this references the same ID used in Catalogs

Report Types : Product reports only
advProductNameAdvertised product name

Report Types : Product reports only
brandIdAdvertised product brand ID

Report Types : Product reports only
brandNameAdvertised product brand name; names are standardized across retailers

Report Types : Product reports only

Attributed Transactions Report Dimensions & Metrics

Column NameColumn TypeDescription
advDateDimensionDate of advertisement
advHourDimensionHour of advertisement
purchasedDateDimensionDate of the attributed product purchase
purchasedHourDimensionHour of the attributed product purchase
daysDifferenceDimensionDays between advertisement and purchase
campaignIdDimensionCampaign ID of the requested report
campaignNameDimensionCampaign name of the request report
lineItemIdDimensionLine item ID of the requested report
lineItemNameDimensionLine item name of the requested report
retailerNameDimensionRetailer name of the retailer the line item served on
pageTypeNameDimensionType of retailer web page an ad creative rendered on, such as home page, browse pages, search pages, product detail pages, checkout pages etc.
keywordDimensionKeyword or phrase used to land on the search page where an ad creative rendered
advProductIdDimensionAdvertised product ID; this references the same ID used in Catalogs
advProductNameDimensionAdvertised product name
advProductCategoryDimensionCategory of product advertised; categories are standardized across brands and retailers, which may differ from retailer-specific categories
advProductGtinDimensionAdvertised product Global Trade Item Number (GTIN), if available; also known as European Article Number (EAN) or Universal Product Code (UPC)
advProductMpnDimensionAdvertised product Manufacturer Part Number (MPN), if available
purchasedProductIdDimensionPurchased product ID; this references the same ID used in Catalogs
purchasedProductNameDimensionPurchased product name
purchasedProductCategoryDimensionCategory of product purchased; categories are standardized across brands and retailers, which may differ from retailer-specific categories
purchasedProductGtinDimensionPurchased product Global Trade Item Number (GTIN), if available; also known as European Article Number (EAN) or Universal Product Code (UPC)
purchasedProductMpnDimensionPurchased product Manufacturer Part Number (MPN), if available
advEngagementDimensionType of ad engagement the purchase was attributed to
advToPurchasedProductRelationshipDimensionAttribution rule used to match the impression or click to a sale
salesChannelDimensionSales channel the attributed purchase was made through
attributionWindowDimensionClick and view attribution window of the requested report
attributedSalesMetricSales revenue attributed to a click or impression
attributedUnitsMetricUnits sold attributed to a click or impression