Get Brand Product Drilldown
GET/api/reporting/brands/:brand/products/:product
Single-product drill-down for one brand: current vs previous purchase/sales totals, a landed-cost-per-receipt trend, and the list of suppliers carrying the same SKU with their cost, lead time and reliability.
Authentication: Requires Bearer token (scope: reports)
Path parameters:
- brand: the Brand ID
- product: the Product ID
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.
Optional:
- growth_basis: spend | sales | profit | margin (default: sales)
- min_volume, include_archived
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not Found
Response Headers
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.