Sign in
Reports

Bookable area occupancy report

For each bookable area at the requested site, returns bookable / blocked / booked minutes across the requested date range. Capped to 60 days per request — for larger ranges, queue an export with /shop/reports/bookable-area-occupancy/queue.

get/shop/reports/bookable-area-occupancy

Query parameters

site_idstring uuid

Restrict the report to the given site.

date_fromstring date required
Example:2026-06-01

Restrict to occupancy on or after this date. Required. The range between date_from and date_to cannot exceed 60 days.

date_tostring date required
Example:2026-06-30

Restrict to occupancy on or before this date. Required.

bookable_area_idsstring[]

A comma-separated list of bookable area IDs to restrict to.

zone_idstring[]

A comma-separated list of zone IDs to restrict bookable areas to.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "bookable_area": {
        "name": "Pool"
      }
    }
  ]
}

Changes

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