Get Brand Report
GET/api/v2/brand-reports/:run
Returns a report run in full: totals, flags, warnings, data-as-of timestamps, channels, narrative (insights and actions), versions and every line.
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Line sections: channel (one per sales channel), product (one per core product, with channel_breakdown keyed by sales_channel_id), amazon (one per watched ASIN per Amazon channel).
On Amazon lines, seller/FBA/Prime counts and the market estimate (market_units, market_sales_amount, market_share_pct, competitor_units, market_basis, market_confidence) are only present when Competition monitoring is on for that channel — they are omitted, not zero, otherwise. Market figures are estimates: market_basis is derived (from your Sales & Traffic: your units ÷ your page-view-weighted Buy Box share), derived_hourly (hourly Buy Box holder × page views; adds competitor_units_by_seller) or keepa; low-confidence estimates are not reported.
Authentication: Requires Bearer token (scope: reports, permission: brand_reports.index).
Request
Responses
- 200
- 401
- 403
- 404
- 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
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.