Analytics
Retrieve the overview
The Overview page's numbers for a period: orders, revenue and visits (with the change against the period before), a series to chart, how far the period's orders got, where their cash stands, couriers, best sellers and top regions. period is today, 7d, 30d, 90d or all; or send start_date and end_date (a year at most). Computed live, by the same code as the dashboard; poll it every few minutes at most.
Query parameters
- periodstring
One of
today,7d,30d,90d,all
default "7d" - start_datestring
date
- end_datestring
date
Returns
200 OK · The overview. AnalyticsOverview
- objectstring
always "analytics_overview"
- periodobject
- summaryobject
8 child fields
- ordersinteger
- orders_change_percentnumber or null
Against the period before. null when there is nothing to compare with.
- revenueMoney
An amount of money.
amountis a decimal STRING with exactly the currency's number of decimals ("1250.00" in DZD, "12.500" in TND) — never parse it into a float.2 child fields
- amountstringRequired
- currencystringRequired
- revenue_change_percentnumber or null
- visitsinteger
Storefront visits.
- visits_change_percentnumber or null
- conversion_ratenumber
Orders per 100 visits.
- visitors_nowinteger
On the storefront in the last 5 minutes.
- seriesarray of objects
- pipelineobject
How far this period's orders got. confirmed and shipped count every order that reached that step or went past it.
- cashobject or null
Where the money of this period's orders stands now.
- couriersarray of objects
- top_productsarray of objects
- top_regionsarray of objects
- open_ordersobject
- livemodeboolean
Errors
Every error has the same shape. This endpoint can answer with:
