Get analytics overview

Returns aggregate metrics for the store across orders, revenue, customers, and refunds. Requires the ANALYTICS_READ scope.

GET https://api.pandabase.io/v2/core/stores/{storeId}/analytics/overview

Authentication

Requires a bearer token (sk_…) or an API key in the header Authorization.

Path parameters

storeId string required

(length 12–48)

Query parameters

period enum

No description.

startDate date-time

(format date-time)

endDate date-time

(format date-time)

Header parameters

idempotency-key string

(length 8–32)

Response 200

Default Response

ok enum required

(one of true)

data object required

No description.

Response 400

Default Response

ok enum required

(one of false)

error string required

No description.

Request
curl -X GET https://api.pandabase.io/v2/core/stores/:storeId/analytics/overview
Response
{  "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"    }  }}