Skip to main content

Statistics

The Statistics API exposes detailed store metrics — revenue, sales, transactions, conversion, average order value, and more — as JSON.

Overview

The Statistics API provides a single endpoint:

Each call returns one statistic as a time-bucketed series for the selected period, the matching previous-period series for comparison, and a server-computed change block summarising the delta. To pull several statistics at once, call the endpoint in parallel with different type values.

Stat types

TypeDomainNotes
revenuemoneyGross order revenue
salescountCompleted orders
transactionscountCaptured payment transactions
checkout_sessionscountInitiated checkouts
customerscountNew paying customers
conversionrateCheckouts that converted to a sale (%)
recovered_revenuemoneyRevenue rescued via abandoned-checkout follow-ups
partners_revenuemoneyRevenue attributed to your affiliate partners
automation_runscountAutomation triggers fired
free_productscountFree-product redemptions
average_order_valuemoneyAverage order value across completed orders
average_customer_lifetime_valuemoneyAverage lifetime spend per customer

Money values are returned as integers in minor units (e.g. 12500 = 125.00 PLN). Count stats are plain counts. conversion is a whole-number percentage recomputed over the whole period (orders vs. checkout sessions); it can exceed 100 when orders outnumber sessions, and is not the sum of the daily rates.

Currency

Every call requires a currency query parameter — figures are scoped to a single currency, and there is no store-level default. See GET /store for the currencies your store transacts in.

Zero-activity responses

A date range with no activity returns a clean zero-shaped response (data: [], totals at 0, change at 0) with a date_range echoing the requested period — not an error.