Space group level metrics for one floor, aggregated over the selected time period.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Example Queries
Path
/metrics/aggregate/space_groups?zone_id=88412-7552&filter[date_range]=this_week&include[]=previous
Description
Retrieve aggregated metrics data for space group 7552 on floor 88412 for this week starting on Sunday, and include aggregated metrics from the previous week to compare against.
Path
/metrics/aggregate/space_groups?zone_id=88412-7552&filter[local_date][gte]=2025-06-18&filter[local_date][lte]=2025-06-22
Description
Retrieve aggregated metrics data for space group 7552 on floor 88412 from June 18, 2025 to June 22, 2025.
Finding the zone_id
Call /v2/buildings/{building_id}/floors/{floor_id}/space_groups. The id field of each entry is already the exact compound value to pass as zone_id, so you do not need to build it yourself. That response also returns the group's name, capacity, and the spaces it contains on that floor.
A bare space group ID without the floor prefix returns a 404.
A space group is scoped to a single floor. If a group spans several floors, request each floor separately. Adding the per-floor peaks together overstates the true peak, because those peaks can occur at different moments.
A group that has no spaces on the requested floor returns zeroed metrics rather than a 404.
Response
| Property | Type | Description |
|---|---|---|
| avg_person_count | Float | Average number of people in the space group over the selected time period. |
| peak_person_count | Int | Maximum number of people present in the space group at any given time during the time period. |
| avg_daily_peak_person_count | Float | Average of the maximum number of people present in the space group each day. |
| avg_capacity_usage | Float | Average percentage of the space group's capacity used over the selected time period. |
| peak_capacity_usage | Float | Maximum percentage of the space group's capacity used at any given time during the selected time period. |
| avg_daily_peak_capacity_usage | Float | Average of the maximum percentage of the space group's capacity used each day. |
Default Time Window
If you omit filter[days_of_week][] and filter[hours_of_day][], the response covers your configured working days and working hours only. To aggregate across the full week, pass every day and hour explicitly.
Dates on your excluded-dates list are always removed and cannot be included.