Generate Brand Report
POST/api/v2/brand-reports
Starts generating a report for a brand now, in the background. Without period_start, the most recent complete period is used.
reports:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports, permission: brand_reports.manage).
Body:
- brand_id (required) — a brand with saved reporting settings
- period_type (required) — weekly | monthly
- period_start (optional, YYYY-MM-DD) — must be a Monday for weekly or the 1st for monthly
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
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.