/metrics/aggregate/spaces

Metrics for all spaces in a building, or company

Example Queries

Path

/metrics/aggregate/spaces?filter[local_date][gte]=2022-08-02&filter[local_date][lte]=2022-08-20&&filter[building_id]=654321

Description

Retrieve aggregated metrics for all spaces contained in building 654321 for the period where local_date is greater than 2022-08-02 and local_date is less than 2022-08-20.

Response

PropertyTypeDescription
avg_person_countIntAverage number of people in the space over the selected time period.
avg_person_count_when_usedIntAverage number of people in the space, but only considering times when it was in use.
peak_person_countIntMaximum number of people present in the space at any given time during the time period.
avg_daily_peak_person_countIntAverage of the highest number of people present in the space each day.
active_minutes_usedIntTotal minutes the space was actively occupied (e.g., when people were engaged in a primary activity).
passive_minutes_usedIntTotal minutes the space was passively occupied (e.g., when people were present but not actively using it).
total_hours_actively_occupiedIntTotal hours the space was actively used during the time period.
pct_active_timeIntPercentage of total available time the space was actively in use.
pct_passive_timeIntPercentage of total available time the space was passively occupied.
avg_capacity_usageIntAverage percentage of the space’s capacity used over the time period.
avg_capacity_usage_when_usedIntAverage percentage of the space’s capacity used, only considering times when it was occupied.
Language
Credentials
Header
Click Try It! to start a request and see the response here!