Get Financial Summary by Period

GET 
/api/financials/summary-by-period

Returns aggregated financial data (revenue, cost, profit) grouped by the specified time period. Used for financial trend charts and reporting dashboards.

Required scope: reports:read

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

Authentication: Requires Bearer token (Power User access required)

Response: Array of period summaries with:

• period: The period label (e.g. '2024-01', 'Q1 2024')
• revenue, cost, profit: Aggregated financial totals
• num_orders: Total order count for the period

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.

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.