API referenceInsights
Revenue, orders, products, spenders and methods for a range, with the previous period
AuthorizationBearer <token>
API key from Settings → API keys
In: header
Path Parameters
storeId*string
Query Parameters
from*string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timeto*string
Match
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Format
date-timecurrency?string
Length
3 <= length <= 3productId?string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidpaymentMethodId?string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/stores/string/insights/sales?from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"{ "currency": "string", "currencies": [ "string" ], "storeCurrencyTotal": { "currency": "string", "revenueMinor": -9007199254740991, "refundedMinor": -9007199254740991, "orders": -9007199254740991, "unconverted": [ "string" ] }, "bucket": "hour", "timezone": "string", "kpis": { "revenueMinor": { "value": 0, "previous": 0 }, "orders": { "value": 0, "previous": 0 }, "customers": { "value": 0, "previous": 0 }, "averageOrderMinor": { "value": 0, "previous": 0 }, "refundedMinor": { "value": 0, "previous": 0 }, "netRevenueMinor": { "value": 0, "previous": 0 }, "estimatedProfitMinor": { "value": 0, "previous": 0 }, "itemsSold": { "value": 0, "previous": 0 }, "costCoverage": -9007199254740991 }, "series": [ { "bucket": "string", "revenueMinor": -9007199254740991, "orders": -9007199254740991 } ], "products": { "best": [ { "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "name": "string", "qty": -9007199254740991, "revenueMinor": -9007199254740991, "prevRevenueMinor": -9007199254740991, "costMinor": -9007199254740991 } ], "risers": [ { "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "name": "string", "qty": -9007199254740991, "revenueMinor": -9007199254740991, "prevRevenueMinor": -9007199254740991, "costMinor": -9007199254740991 } ], "decliners": [ { "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113", "name": "string", "qty": -9007199254740991, "revenueMinor": -9007199254740991, "prevRevenueMinor": -9007199254740991, "costMinor": -9007199254740991 } ] }, "topSpenders": [ { "email": "string", "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac", "orders": -9007199254740991, "revenueMinor": -9007199254740991 } ], "methods": [ { "paymentMethodId": "b6df8625-cd25-4123-b345-638aa7b5d011", "label": "string", "provider": "string", "orders": -9007199254740991, "revenueMinor": -9007199254740991 } ], "latest": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": -9007199254740991, "productName": "string", "extraItems": -9007199254740991, "methodLabel": "string", "provider": "string", "totalMinor": -9007199254740991, "currency": "string", "paidAt": "string", "status": "string" } ]}