Sign in
Reports

Room occupancy report

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

get/shop/reports/room-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.

room_idsstring[]

A comma-separated list of room IDs to restrict to.

zone_idstring[]

A comma-separated list of zone IDs to restrict rooms to.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "room": {
        "id": "60a8c0901d210625e3a87667",
        "name": "Treatment Room 1"
      },
      "bookable_mins": 2400,
      "appointment_mins": 1500,
      "session_mins": 200,
      "blocked_mins": 60
    }
  ]
}

Changes