Analyze promotional activity in a category
Analyze promotional activity within a category - promo frequency, average and max discount depth - over a date range. Pivot the breakdown with aggregate_by: default brand ranks brands within the category; retailer ranks retailers (use together with brand=<name> to answer ‘which retailers run the deepest promos on Brand X in Category Y’). The response key mirrors the dimension: brands: [...] or retailers: [...].
Query Parameters
Product category. Accepts a human-readable name (e.g. 'electronics', 'beauty') or a taxonomy slug path (e.g. 'electronics/headphones'); matched against the catalog's category tree (exact node, subtree, or path substring). Also accepts a GS1 GPC code (exactly 8 digits, e.g. '10001159') to filter by PRODUCT TYPE instead of by shelf placement — the same product type is shelved under different categories by different retailers, so a category filter answers from a fraction of the data while a GPC code spans them. Coarser codes (class/family/segment) match every brick beneath them. Resolve a phrase to a code with /v1/reference/classify?q=... ; when a code is used, resolved.match_source is 'gpc'.
1Country (us or ca)
us, ca Filter to a specific retailer platform (long-tail specialty stores are also present; any platform key is accepted)
amazon, walmart, target, bestbuy, homedepot, costco, ikea, samsclub, cvs, dillards Optional brand filter — limit aggregation to products of this brand (case-insensitive)
1Group-by dimension. brand (default) ranks brands within the category. retailer ranks retailers — pair with brand to answer 'which retailers run the deepest promos on Brand X'.
brand, retailer Historical window preset. Explicit from/to takes precedence and is reported as custom; time_window=custom requires both from and to. Date-only ranges use UTC calendar boundaries with inclusive from and exclusive to.
last_30_days, last_60_days, last_90_days, month_to_date, previous_month, month_over_month, quarter_to_date, custom Start date (ISO 8601, defaults to 30 days ago)
End date (ISO 8601, defaults to now)

