Space type level metrics for one floor, aggregated over the selected time period.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Example Queries
Path
/metrics/aggregate/space_types?zone_id=88412-open_focus&filter[date_range]=this_week&include[]=previous
Description
Retrieve aggregated metrics data for the Open Focus space type on floor 88412 for this week starting on Sunday, and include aggregated metrics from the previous week to compare against.
Path
/metrics/aggregate/space_types?zone_id=88412-open_focus&filter[local_date][gte]=2025-06-18&filter[local_date][lte]=2025-06-22
Description
Retrieve aggregated metrics data for the Open Focus space type on floor 88412 from June 18, 2025 to June 22, 2025.
Finding the zone_id
Call /v2/buildings/{building_id}/floors/{floor_id}/space_types. 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. The second half of the value is the space type key, a string, not a numeric ID.
A bare space type ID without the floor prefix returns a 404.
Both default and custom space types are supported. A custom key may itself contain a hyphen; the value is split on the first hyphen only, so no escaping is needed.
Response
| Property | Type | Description |
|---|---|---|
| avg_person_count | Float | Average number of people in the space type over the selected time period. |
| peak_person_count | Int | Maximum number of people present in the space type 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 type each day. |
| avg_capacity_usage | Float | Average percentage of the space type's capacity used over the selected time period. |
| peak_capacity_usage | Float | Maximum percentage of the space type'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 type'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.