Sales summary [+]
Studio
Sales summary [+]
Revenue, order count, average order value, and withheld tax for a period, with previous-period comparison.
GET
Sales summary [+]
Aggregated sales figures for a calendar period, alongside the equivalent previous period and percentage deltas, everything you need for a “this month vs last month” stat card.
Tier: Premium, requires a premium key and an active Branding+ subscription (checked on every request).
Request
Query parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
period | string | thisMonth | today, thisWeek, thisMonth, or thisYear. |
Response
| Field | Description |
|---|---|
current / previous | Totals for the requested period and the immediately preceding one (numbers, in USD dollars). Only completed sales count. |
current.revenue | Net revenue credited to the studio. |
current.tax | VAT withheld across the period’s sales. |
deltas | Percentage change vs the previous period. 100 when the previous period was zero and the current isn’t. |
Errors
| HTTP | Code | When |
|---|---|---|
| 403 | PREMIUM_KEY_REQUIRED | The key is basic-tier. |
| 403 | SUBSCRIPTION_INACTIVE | Premium key, but the Branding+ subscription is no longer active. |