Reports

Top customers report

Returns the top 100 customers by net total across the filter range, sorted by net total descending. The customer name returned is the one most frequently used on the orders matched — the source-of-truth customer record lives in the Customers API.

For large date ranges or background CSV delivery, queue an export with /shop/reports/top-customers/queue.

get/shop/reports/top-customers

Query parameters

site_idstring uuid

Restrict the report to baskets at the given site.

revenue_date_fromstring date

Example:2026-01-01

Restrict to baskets with a revenue date on or after this date.

revenue_date_tostring date

Example:2026-12-31

Restrict to baskets with a revenue date on or before this date.

submitted_at_fromstring date

Restrict to baskets submitted on or after this date.

submitted_at_tostring date

Restrict to baskets submitted on or before this date.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "id": "60a8c0901d210625e3a87667",
      "full_name": "Jane Doe",
      "num_orders": 8,
      "total_value_gross": 240000,
      "average_value_gross": 30000,
      "total_value_net": 200000,
      "average_value_net": 25000
    }
  ]
}

Changes

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