Portfolio level metrics across every building you can access, aggregated over the selected time period.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Example Queries
Path
/metrics/aggregate/portfolio?filter[date_range]=last_month
Description
Retrieve aggregated metrics data across every building you can access for last month.
Path
/metrics/aggregate/portfolio?filter[local_date][gte]=2025-06-18&filter[local_date][lte]=2025-06-22
Description
Retrieve aggregated metrics data across every building you can access from June 18, 2025 to June 22, 2025.
This endpoint takes no ID. It covers every building your API key can access. Buildings without a ready floor are excluded.
Response
| Property | Type | Description |
|---|---|---|
| avg_person_count | Float | Average number of people in the portfolio over the selected time period. |
| peak_person_count | Int | Maximum number of people present in the portfolio at any given time during the time period. |
| avg_daily_peak_person_count | Float | Average of the maximum number of people present in the portfolio each day. |
| avg_capacity_usage | Float | Average percentage of the portfolio's capacity used over the selected time period. |
| peak_capacity_usage | Float | Maximum percentage of the portfolio'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 portfolio'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.