---
title: "Room occupancy report"
method: GET
path: "/shop/reports/room-occupancy"
tags: ["Reports"]
---

# Room occupancy report

`GET /shop/reports/room-occupancy`

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`](/endpoints/Reports#queueRoomOccupancyExport).

## Query parameters

- `site_id` string, uuid
- `date_from` string, date, required
- `date_to` string, date, required
- `room_ids` string[]
- `zone_id` string[]

## Response `200`

The report was successfully generated.

- RoomOccupancyResponse — For each room at the site, the number of bookable / appointment / session / blocked minutes across the requested date range.
  - `data` RoomOccupancyRow[], required
    - `room` RoomOccupancyRoom, required
      - `id` string, object-id, required
      - `name` string, required
    - `bookable_mins` integer, required
    - `appointment_mins` integer, required
    - `session_mins` integer, required
    - `blocked_mins` integer, required
  - `totals` RoomOccupancyTotals, required
    - `bookable_mins` integer, required
    - `appointment_mins` integer, required
    - `session_mins` integer, required
    - `blocked_mins` integer, required

## Other responses

- `400` — The request failed.

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)
