Skip to main content
GET
Get Analytics

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The shop ID.

Query Parameters

products
object[]

Up to 5 products to scope the analytics to, each as product_id plus an optional variant_ids array.

Example:

null

Response

200 - application/json
revenue
number
Example:

14.99

previousRevenue
integer
Example:

0

revenueChange
integer
Example:

1499

orders
integer
Example:

3

previousOrders
integer
Example:

0

ordersChange
integer
Example:

300

customers
integer
Example:

2

previousCustomers
integer
Example:

0

customersChange
integer
Example:

200

cogs
number
Example:

13.5

profit
number
Example:

1.49

previousProfit
integer
Example:

0

profitChange
integer
Example:

149

costCoverage
integer
Example:

100

hasCosts
boolean
Example:

true