Get yield insights room and area occupancy
Returns how full each of a site's bookable resources was by hour over a recent reporting period, so an operator can see which rooms carry the demand and which sit empty.
Each average is the share of that resource's bookable minutes which were booked in that hour across the period, with time blocked out by staff reducing capacity rather than counting as demand. An average is null rather than 0 where nothing was bookable, so a closed hour reads differently from an empty one.
Rows cover treatment rooms today; kind distinguishes them from bookable areas, which are added as further rows once their capacity is measured.
avgs is empty until the underlying calculation has data to work from, while the rows themselves are always returned, so a grid can render its axes before any fill rate exists.
Query parameters
The site to return yield insights for.
The reporting period to calculate results over, ending now. Defaults to last_30_days. Shared by the yield insights endpoints so a dashboard can request every panel over the same window.
Response
The room and area occupancy grid was successfully retrieved.
Example response
{
"data": {
"period": "last_30_days",
"has_occupancy_data": true,
"heatmap": [
{
"id": "5f4f1a3b9c9d440000d1f1a1",
"name": "Treatment Room 1",
"kind": "room",
"avgs": {
"09:00": 45,
"11:00": 62
}
}
],
"quiet_threshold_percent": 40,
"high_threshold_percent": 70,
"peak_threshold_percent": 90
}
}Changes
No recorded changes to this endpoint across all 1 revision of this API.