Sign in
Analytics

Get Analytics

Retrieves revenue, orders, customers and estimated gross profit analytics in a given timeframe.

get/v1/shops/{shopId}/analytics

Response

revenuenumber
previousRevenueinteger
revenueChangeinteger
ordersinteger
previousOrdersinteger
ordersChangeinteger
customersinteger
previousCustomersinteger
customersChangeinteger
cogsinteger
profitnumber
previousProfitinteger
profitChangeinteger
costCoverageinteger
hasCostsboolean

Example response

{
  "revenue": 14.99,
  "previousRevenue": 0,
  "revenueChange": 1499,
  "orders": 2,
  "previousOrders": 0,
  "ordersChange": 200,
  "customers": 2,
  "previousCustomers": 0,
  "customersChange": 200,
  "cogs": 9,
  "profit": 5.99,
  "previousProfit": 0,
  "profitChange": 599,
  "costCoverage": 100,
  "hasCosts": true
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.