Store APIsAnalytics
Get analytics overview
Returns aggregate metrics for the store across orders, revenue, customers, and refunds. Requires the ANALYTICS_READ scope.
AuthorizationBearer <token>
Bearer token authentication. Pass the secret directly in the Authorization header. Token secrets start with sk_.
In: header
Path Parameters
storeId*string
Length
12 <= length <= 48Query Parameters
period?||||||
startDate?string
Format
date-timeendDate?string
Format
date-timegranularity?|
Header Parameters
idempotency-key?string
Length
8 <= length <= 32Response Body
application/json
application/json
curl -X GET "https://example.com/stores/stringstring/analytics/overview"{ "ok": true, "data": { "grossVolume": 1248900, "netVolume": 1141500, "orders": 432, "customers": 318, "refunded": 12, "disputes": 2, "period": { "from": "2026-04-14T00:00:00.000Z", "to": "2026-05-14T00:00:00.000Z" } }}