Skip to main content
GET
PublicApiGetUsageSummary
Use this endpoint through the Developer API or the matching firstsales CLI command when available. Responses use the stable FirstSales public error envelope.

Authorizations

Authorization
string
header
required

FirstSales developer API key bearer token (fs-key-*).

Path Parameters

orgId
string
required

Query Parameters

days
integer
default:30
Required range: 1 <= x <= 90
from
string
Pattern: ^\d{4}-\d{2}-\d{2}$
to
string
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Successful response

daily
object[]
required
Maximum array length: 366
byAction
object[]
required
Maximum array length: 21
totalConsumed
number
required
grossSpend
number
required
totalRefunds
number
required
distinctUsed
integer
required
Required range: 0 <= x <= 9007199254740991
periodDays
integer
required
Required range: 1 <= x <= 9007199254740991
clamped
boolean
required