Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Data

Get Sensor Data

Returns all sensor readings for a particular sensor over a specified time range.

Responses will include the start and end time of the data requested and device information (ID, serial number) alongside the readings.

get/environment/v1/data

Query parameters

device_idstring required

The unique identifier of the device.

start_timeinteger

The start of the time range for requested sensor data. Formatted as a Unix timestamp in seconds. Defaults to an hour from the current time.

end_timeinteger

The end of the time range for requested sensor data. Formatted as a Unix timestamp in seconds. Defaults to the current time.

page_tokenstring

The pagination token used to fetch the next page of results.

page_sizeinteger

The number of items returned in a single response. Default is 100. Max is 200.

fieldsstring

One or multiple comma separated values from <code>humidity</code>, <code>motion</code>, <code>noise_level</code>, <code>pm_2_5</code>, <code>pm_4_0</code>, <code>pm_1_0_0</code>, <code>tamper</code>, <code>temperature</code>, <code>tvoc</code>(SV11), <code>usa_air_quality_index</code>, <code>vape_index</code>, <code>carbon_dioxide</code>, <code>carbon_monoxide</code>, <code>barometric_pressure</code>, <code>formaldehyde</code>, <code>ambient_light</code>, <code>tvoc_index</code>(SV23/SV25), <code>heat_index</code>.

If blank, all sensor readings will be returned in the response.

intervalstring

The time interval for the requested sensor data.

Data is stored with 1 second intervals for 30 days, and with 5 minute intervals for data between 30 days and 365 days old.

A valid value for this field is a number followed by a supported format. Supported formats are <code>s</code>, <code>m</code>, and <code>h</code> for seconds, minutes, and hours, respectively.

For example, 5m would specify a 5 minutes interval for the data.

If left blank, a default resolution will be calculated based on time range.

Response

OK

dataobject[]
device_idstring uuid

The unique identifier of the device.

device_namestring

The name of the device.

device_serialstring

The serial number of the device.

intervalstring

The time interval of the requested sensor data.

next_page_tokenstring

The pagination token used to fetch the next page of results.

Example response

{
  "data": [
    {
      "heat_index": 20.837427,
      "humidity": 51.507164,
      "motion": 0,
      "noise_level": 51.139782,
      "pm_1_0_0": 0.072837172,
      "pm_2_5": 0.033870004,
      "pm_4_0": 0.039784023,
      "tamper": 0,
      "temperature": 20.837427,
      "time": 1639592320,
      "tvoc": 769,
      "usa_air_quality_index": 0,
      "vape_index": 0,
      "vape_index_experimental": 0
    },
    {
      "heat_index": 20.837427,
      "humidity": 51.507164,
      "motion": 0,
      "noise_level": 51.257225,
      "pm_1_0_0": 0.072837172,
      "pm_2_5": 0.033870004,
      "pm_4_0": 0.039784023,
      "tamper": 0,
      "temperature": 20.837427,
      "time": 1639592321,
      "tvoc": 753,
      "usa_air_quality_index": 0,
      "vape_index": 0,
      "vape_index_experimental": 0
    }
  ],
  "device_id": "1dfba4f5-1718-46be-afd7-c91bc5674201",
  "device_name": "Lobby Sensor",
  "device_serial": "JQ9R-R9CG-RF6X",
  "device_site_name": "First Floor Devices",
  "page_cursor": 1639592321,
  "resolution": "1s"
}