buildings_sensors_export
GET/public-api/buildings/:uuid/sensors/export/
Pre-requisites
- uuid: You need a (building) uuid for this endpoint. You can get a list of buildings with
GET /buildings/. - sensor_uuid: You need a sensor_uuid for this endpoint. You can get a list of sensors with
GET /buildings/{uuid}/sensors/. Note: this is not the id of the sensor (example sensor_uuid: 153cde21-5967-4f25-b7f1-3325083c7695).
Export data in CSV (default) or JSON for sensor for one day. Output format can be controlled using the Accept header (Accept: text/csv or Accept: application/json), or using the format= query parameter. Note: when using the format= parameter make sure to use the correct Accept: header (or use Accept: */*)
If no timestamp is provided, data of today will be returned. Otherwise, data of day which belongs to provided timestamp will be returned.
If no interval is provided, the default interval of that sensor type will be returned.
The minimum interval of entries by sensors of type "meter_reading" depends on the configured interval. By default this is set to day. This configured interval will be used if no interval is provided.
The minimum interval can be configured depending on the type of meter and local configuration. Please contact operations@envitron.com for more information. Currently configured minimum intervals can be retrieved with GET /buildings/{id}/sensors/.
Notice: All minute aggregations are preserved for only 3 months. If you need data older than 3 months, you can make use of a lower interval rate.
Intervals and units of the different sensor types (if data available):
| Sensor type | Interval (default) | Interval options | Unit |
|---|---|---|---|
| energy/electricity | 1 minute | minute, quarter, hour, day | watt |
| energy/gas | 1 minute | minute, hour, day | m3 |
| energy/heat | 15 minutes | quarter, hour, day | GJ |
| energy/water | 15 minutes | quarter, hour, day | m3 |
| energy/meter_reading | depends on config (max. 1 day) | minute, quarter, day | electricity: kWh / gas: m3 / heat: GJ / water: m3 |
| comfort/humidity | 15 minutes | quarter, day | percentage |
| comfort/temperature | 15 minutes | quarter, day | °C |
| comfort/illuminance | 15 minutes | quarter, day | lux |
| switch/motion | all events | ||
| switch/contact | all events | ||
| key/value | all registrations |
Request
Responses
- 200
- 400
- 404
- 406
- 429
Invalid request
Building not found
Requested format parameter conflicts with accepted media type
Too many requests