Skip to main content
GET
Analyze promotional activity in a category

Query Parameters

category
string
required

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'.

Minimum string length: 1
country
enum<string>
default:us

Country (us or ca)

Available options:
us,
ca
retailer
enum<string>

Filter to a specific retailer platform (long-tail specialty stores are also present; any platform key is accepted)

Available options:
amazon,
walmart,
target,
bestbuy,
homedepot,
costco,
ikea,
samsclub,
cvs,
dillards
brand
string

Optional brand filter — limit aggregation to products of this brand (case-insensitive)

Minimum string length: 1
aggregate_by
enum<string>
default:brand

Group-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'.

Available options:
brand,
retailer
time_window
enum<string>

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.

Available options:
last_30_days,
last_60_days,
last_90_days,
month_to_date,
previous_month,
month_over_month,
quarter_to_date,
custom
from
string<date>

Start date (ISO 8601, defaults to 30 days ago)

to
string<date>

End date (ISO 8601, defaults to now)

Response

Promo intelligence

category
string
country
string
currency
string
retailer
string | null
brand
string | null
aggregate_by
enum<string>
Available options:
brand,
retailer
window
object
brands
object[]
retailers
object[]
resolved
object
meta
object