Reports

Top offerings report

Returns the top-selling offerings (appointments, sessions, products, packages, etc.) across the filter range, alongside per-offering-type roll-up totals. Useful for headline "what's our best seller" dashboards.

For background CSV delivery, use /shop/reports/top-offerings/queue.

get/shop/reports/top-offerings

Query parameters

site_idstring uuid

Restrict to items at the given site.

revenue_date_fromstring date

Example:2026-01-01

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

revenue_date_tostring date

Example:2026-12-31

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

item_date_fromstring date

Restrict to items dated on or after this date.

item_date_tostring date

Restrict to items dated on or before this date.

offering_typestring

Filter to items of a particular offering type.

offering_idsstring[]

A comma-separated list of offering IDs to filter on.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "offering_type": "appointment",
      "offering_name": "60 Minute Massage"
    }
  ],
  "totals": {
    "by_offering_type": [
      [
        {
          "offering_type": "appointment"
        }
      ]
    ]
  }
}

Changes

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