Get Financials by Brand

GET 
/api/reporting/financials-by-brand

Returns financial summary data grouped by brand.

Required scope: reports:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

A date range is required: pass filter[start_date] and filter[end_date] (Y-m-d). Requests without them are rejected with 422. The report returns one row per group, with a column per interval between the two dates plus a Total column.

Authentication: Requires Bearer token

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

422

Unprocessable Content

Response Headers

Content-Type

429

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.