Sign in
Reports

Get KPI stats report

Returns per-day basket statistics and range totals over a configurable date range (defaulting to the last 30 days). Shows total basket counts and average values, with website baskets (source=shop_v2) broken out separately. Per-day data includes an entry for every date in the requested range, even when no baskets exist for that day (zero-count entries are included). The summary provides aggregated totals across the entire date range. Requires the DASHBOARDS_VIEW permission.

get/shop/reports/kpi-stats

Query parameters

site_idstring required

Filter results by the site they belong to

date_fromstring date

Restrict results to those on or after this date, ISO-8601 YYYY-MM-DD.

date_tostring date

Restrict results to those on or before this date, ISO-8601 YYYY-MM-DD.

Response

KPI stats report data.

Example response

{
  "data": {
    "by_date": [
      {
        "date": "2024-01-15",
        "all_baskets_count": 42,
        "all_baskets_average_value": 7500,
        "website_baskets_count": 28,
        "website_baskets_average_value": 6800
      }
    ],
    "summary": {
      "all_baskets_count": 420,
      "all_baskets_average_value": 7200,
      "website_baskets_count": 280,
      "website_baskets_average_value": 6500
    }
  },
  "meta": {
    "currency": "gbp"
  }
}

Changes