Skip to main content
POST
Get Stats

Request Body

A JSON body is required, even if empty ({}). Sending no body returns a 400 error.

Example Request

Example Response

The periodStart and periodEnd fields in the usage object will be null if there is no active subscription.

Error Responses

Authorizations

X-API-KEY
string
header
required

API key for authentication

Body

application/json

Stats request parameters

period
enum<string>
default:current

Period to retrieve statistics for

Available options:
current,
previous,
custom
startDate
string<date>

Start date (YYYY-MM-DD). Required when period is custom.

Example:

"2026-01-01"

endDate
string<date>

End date (YYYY-MM-DD). Required when period is custom.

Example:

"2026-03-01"

Response

Statistics retrieved successfully

success
boolean
Example:

true

data
object
meta
object