Skip to main content
GET
Get store metrics summary

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Query Parameters

startDate
number

Start of the date range as a Unix timestamp in milliseconds (e.g. 1740614400000). When provided with endDate, filters totals to this range. Required when interval is specified.

endDate
number

End of the date range as a Unix timestamp in milliseconds (e.g. 1772150400000). When provided with startDate, filters totals to this range. Required when interval is specified.

interval
enum<string>

Groups time-series data into buckets of this size. Requires startDate and endDate. Returns a periods array with one entry per bucket containing grossRevenue and netRevenue.

Available options:
day,
week,
month
currency
enum<string>
required
Available options:
EUR,
USD

Response

Successfully retrieved store metrics summary

totals
object
required

Aggregated totals for the queried date range

periods
object[]

Time-series data points grouped by the requested interval. Only present when interval, startDate, and endDate are provided.

Example: