Get calendar occupancy
Returns occupancy metrics for the operator calendar on a given date. The response counts the guests covered by all confirmed/waitlisted offerings (appointments, area bookings, and sessions) that fall within the date — bucketed by hour, by selected view, and as a single daily total.
Occupancy is gated by the occupancy_overview feature flag. If the flag is off for the site, the underlying data resolves to null. Filter results by view_type (and optionally zone_id) to constrain the calculation to a single resource lane.
Query parameters
The date to fetch events for
A comma-separated list of event keys and event types to return. The format is {event_type}..{event_key}, for example: appointment..1234_5678,session..5678_9012
The view type (resource) to return events for. If specified, an event object will be returned for each resource of this type in the event.
The zone ID to filter events for.
Filter results by the site they belong to
Response
Calendar occupancy successfully retrieved.
Example response
{
"data": {
"occupancy_for_view": 42,
"occupancy_per_day": 87,
"occupancy_per_hour": [
{
"guests": 6,
"time": "09:00"
}
]
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.