---
title: "Occupancy overview"
method: GET
path: "/shop/reports/occupancy-overview"
tags: ["Reports"]
---

# Occupancy overview

`GET /shop/reports/occupancy-overview`

A daily occupancy roll-up for a site, combining booked-basket counts, session counts
and capacity, blocked-time minutes, and the same per-day numbers reported by the
practitioner and room occupancy reports. Intended to power a single-screen overview of
"how busy is this site this week". Capped to 7 days per request.

## Query parameters

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

## Response `200`

The overview was successfully generated.

- OccupancyOverviewResponse
  - `data` OccupancyOverviewDay[], required — One entry per day in the requested range, in date order.
    - `date` string, date, required
    - `baskets` OccupancyOverviewBaskets, required
      - `num_baskets` integer, required
      - `num_booked_appointments` integer
      - `num_booked_sessions` integer
      - `num_booked_packages` integer
    - `sessions` OccupancyOverviewSessions, required
      - `num_sessions` integer, required
      - `total_session_capacity` integer, required
      - `total_session_booked_customers` integer, required
    - `blocked_times` OccupancyOverviewBlockedTimes, required
      - `num_blocked_times` integer, required
      - `total_mins` integer, required — The total number of minutes blocked off across the day.
    - `practitioners` OccupancyOverviewPractitioners, required — Per-day roll-up of the practitioner occupancy report. Mirrors the shape of the same report at [`/shop/reports/practitioner-occupancy-by-date`](/endpoints/Reports#getPractitionerOccupancyByDateReport).
    - `rooms` OccupancyOverviewRooms, required — Per-day roll-up of room occupancy minutes. Mirrors the shape of the same report at [`/shop/reports/room-occupancy`](/endpoints/Reports#listRoomOccupancy).

## 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)