Get Brand Scorecard Summary
GET/api/reporting/brands/:brand/scorecard-summary
Lightweight scorecard + volume sparklines for the brand Profile chip. Returns the composite scorecard with its dimension breakdown, a directional composite trend hint (up | down | flat), and trailing-12-month purchase/sales volume sparklines. The period is fixed to YoY.
Authentication: Requires Bearer token (scope: reports)
Path parameters:
- brand: the Brand ID
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.