API Reference
API ReferenceChangelogLog In
API Reference

Hourly metrics for floors

Example Queries

Path

/metrics/hourly/buildings?filter[local_date][gt]=2022-08-02&filter[local_date][lt]=2022-08-20&filter[local_hour][gt]=4&filter[building_ref_id]=Skyline_Blvd_HQ

Description

Retrieve all hourly building 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 building_ref_id equals Skyline_Blvd_HQ.

Hourly Floor Metric Attributes

PropertyTypeDescription
local_dateStringLocal date, formatted YYYY-MM-DD
local_hourNumberLocal hour between 0-23
capacityNumberCapacity of the floor which the metric belongs at the time when the metric was recorded.
avg_person_count StringAverage person count of spaces on the floor during the hour.
avg_occupied_person_countString or nullAverage person count of spaces on the floor when they are occupied during the hour.
min_person_count NumberMinimum amount of people on the floor during the hour.
max_person_countNumberMaximum amount of people on the floor during the hour.
minutes_actively_occupiedStringAmount of minutes that the spaces on the floor were actively occupied during the hour.
minutes_passively_occupied StringAmount of minutes that the spaces on the floor were passively occupied during the hour.
space_countNumber or nullThe number of spaces on the floor that were included in the hourly floor metric.

Query Parameters

local_date and local_hour have 6 different comparison operators.

filter[<local_date/local_hour>][<operator>]=<value to filter against>

OperatorDescription
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
Language
Credentials
Header
Click Try It! to start a request and see the response here!