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.
get/shop/reports/occupancy-overview
Query parameters
site_idstring uuid required
The site to compute the overview for.
date_fromstring date required
Example:2026-06-15
The first date in the overview. Required. The range between date_from and date_to cannot exceed 7 days.
date_tostring date required
Example:2026-06-21
The last date in the overview. Required.
zone_idstring[]
A comma-separated list of zone IDs to restrict practitioners and rooms to.
Response
The overview was successfully generated.
Example response
{
"data": [
{
"baskets": {
"num_baskets": 35,
"num_booked_appointments": 22,
"num_booked_sessions": 5,
"num_booked_packages": 8
},
"sessions": {
"num_sessions": 6,
"total_session_capacity": 60,
"total_session_booked_customers": 32
}
}
]
}