get
https://api.vergesense.com/metrics/aggregate/buildings/
Building level metrics, aggregated over the selected time period.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Example Queries
Path
/metrics/aggregate/buildings/762016?filter[date_range]=this_week&include[]=previous
Description
Retrieve aggregated metrics data for building 762016 for this week starting on Sunday, and include aggregated metrics from the previous week to compare against.
Path
/metrics/aggregate/buildings/762016?filter[local_date][gte]=2025-06-18&filter[local_date][lte]=2025-06-22
Description
Retrieve aggregated metrics data for building 762016 from June 18, 2025 to June 22, 2025.
Response
| Property | Type | Description |
|---|---|---|
| avg_person_count | Float | Average number of people in the building over the selected time period. |
| peak_person_count | Int | Maximum number of people present in the building at any given time during the time period. |
| avg_daily_peak_person_count | Float | Average of the maximum number of people present in the building each day. |
| avg_capacity_usage | Float | Average percentage of the building's capacity used over the selected time period. |
| peak_capacity_usage | Float | Maximum percentage of the building'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 building's capacity used each day. |