Get Brand Overview
GET/api/reporting/brands/overview
Macro brand dashboard for the resolved period: headline KPIs (purchase volume, sales volume, profit, active brands), the hottest/coldest movers, a 12-month growth heatmap, and the full leaderboard. KPIs and trends are read from monthly brand metric snapshots.
Authentication: Requires Bearer token (scope: reports)
Required parameters:
- period_mode: yoy | qoq | mom | custom
When period_mode=custom, date_from and date_to (YYYY-MM-DD or m/d/Y) are both required and date_to must be on or after date_from.
Optional:
- growth_basis: spend | sales | profit | margin (default: sales) — the basis used to rank movers and the heatmap
- min_volume: numeric — minimum purchase volume before a brand qualifies as a mover (default: 1000)
- include_archived: boolean — include archived brands (default: false)
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.