Neighborhood level metrics, aggregated over the selected time period.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Example Queries
Path
/metrics/aggregate/neighborhoods/44219?filter[date_range]=this_week&include[]=previous
Description
Retrieve aggregated metrics data for neighborhood 44219 for this week starting on Sunday, and include aggregated metrics from the previous week to compare against.
Path
/metrics/aggregate/neighborhoods/44219?filter[local_date][gte]=2025-06-18&filter[local_date][lte]=2025-06-22
Description
Retrieve aggregated metrics data for neighborhood 44219 from June 18, 2025 to June 22, 2025.
Finding the neighborhood ID
This endpoint takes the neighborhood's zone ID, which is not the same as its neighborhood record ID. Call /v2/buildings/{building_id}/floors/{floor_id}/neighborhoods and use the id field of each entry.
Response
| Property | Type | Description |
|---|---|---|
| avg_person_count | Float | Average number of people in the neighborhood over the selected time period. |
| peak_person_count | Int | Maximum number of people present in the neighborhood at any given time during the time period. |
| avg_daily_peak_person_count | Float | Average of the maximum number of people present in the neighborhood each day. |
| avg_capacity_usage | Float | Average percentage of the neighborhood's capacity used over the selected time period. |
| peak_capacity_usage | Float | Maximum percentage of the neighborhood'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 neighborhood'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.