get https://api.vergesense.com/metrics/hourly/neighborhoods
Hourly metrics for neighborhoods
Example Queries
Path
/metrics/hourly/neighborhoods?filter[local_date][gt]=2022-08-02&filter[local_date][lt]=2022-08-20&filter[local_hour][gt]=4&filter[ref_id]=floor_5_west
Description
Retrieve all hourly neighborhood metrics where the local_date is greater than 2022-08-02 and local_date is less than 2022-08-20 and the local_hour is greater than 4 and the neighborhood's ref_id equals floor_5_west.
Hourly Neighborhood Metric Attributes
| Property | Type | Description |
|---|---|---|
local_date | String | Local date, formatted YYYY-MM-DD |
local_hour | Number | Local hour between 0-23 |
capacity | Number | Capacity of the neighborhood which the metric belongs at the time when the metric was recorded. |
avg_person_count | String | Average person count of spaces on the neighborhood during the hour. |
avg_occupied_person_count | String or null | Average person count of spaces on the neighborhood when they are occupied during the hour. |
min_person_count | Number | Minimum amount of people on the neighborhood during the hour. |
max_person_count | Number | Maximum amount of people on the neighborhood during the hour. |
minutes_actively_occupied | String | Amount of minutes that the spaces on the neighborhood were actively occupied during the hour. |
minutes_passively_occupied | String | Amount of minutes that the spaces on the neighborhood were passively occupied during the hour. |
space_count | Number or null | The number of spaces on the neighborhood that were included in the hourly neighborhood metric. |
Query Parameters
local_date and local_hour have 6 different comparison operators.
filter[<local_date/local_hour>][<operator>]=<value to filter against>
| Operator | Description |
|---|---|
eq | == is equal to |
not_eq | != is not equal to |
lt | < is less than |
lte | <= is less than or equal to |
gt | > is greater than |
gte | >= is greater than or equal to |