Analytics API

Common query parametersCopy Anchor Link

Most reads share the same window selection:

• period: a preset window, one of 7d, 14d, 30d, 60d, 90d, mtd, qtd, ytd, 1y, all. Defaults to 30d. Ignored when both from and to are supplied; an unknown value falls back to the default rather than failing.
• from, to: an explicit YYYY-MM-DD range. Takes precedence over period when both ends are provided.
• project_id: an optional project id. Scopes the response to a single project; omit for every project visible to the token. A project outside the token's scope:project: allow-list is 404 TENANT_MISMATCH, an unknown one 404 RESOURCE_NOT_FOUND.

The dashboard, earnings and transaction-breakdown reads additionally accept filter allow-lists: plan_ids, statuses, payment_method_ids. Pass each as an array (?plan_ids[]=uuid1&plan_ids[]=uuid2) or as one comma-separated string (?plan_ids=uuid1,uuid2).

CachingCopy Anchor Link

All reads share the same 5-minute cache the creator dashboard uses. A REST call warms the human-facing view and vice versa; consecutive calls with identical filters hit the cache until it rotates.

The service layer returns USD-normalised totals for cross-currency comparability. Per-plan or per-payment rows still carry their original currency alongside the USD-normalised amount.