/metrics/aggregate/buildings

get

https://api.vergesense.com/metrics/aggregate/buildings/{building_id}

Building level metrics, aggregated over the selected time period.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

building_id

integer

required

ID of the building to get metrics for

Query Params

filter[local_date][gte]

string

Start of the time interval (interval includes this date).

filter[local_date][lte]

string

End of the time interval (interval includes this date).

include[]

string

Defaults to previous

May optionally set this parameter to 'previous' to include comparison data from a previous time range. The previous time range will be automatically generated based on the time range selected.

filter[date_range]

string

Defaults to today

Must be one of the following: today, this_week, last_week, this_month, last_month, this_year, last_year. A request must include either this date range parameter or start and end date parameters as described above.

filter[days_of_week][]

integer

Must be an integer within the range of 0-6. The week starts on Sunday (i.e. 0 = Sunday).

filter[hours_of_day][]

integer

Must be an integer within the range of 0-23. Defaults to working hours.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Bad Request