get https://api.vergesense.com/hardware/sensors
Fetch all sensors.Response conforms to the JSON API spec https://jsonapi.org/.Responses are limited to 1,000
sensors after which pagination will take place.
Response
Hardware Sensor Model
Field | Description | Data Type |
---|---|---|
id | Unique identifier for the VergeSense hardware sensor. Ex: W00-123 | String |
type | sensor | String |
attributes.model | VergeSense hardware model. Ex: L302 , E105 | String |
attributes.firmware | Firmware version of the sensor (if available). | String |
attributes.mac_address | MAC address of the sensor. | String |
attributes.state | Current lifecycle state of the sensor. Can be one of the following:pre_install installed partitioned verified operational flagged | String |
attributes.network.status | Current network status of the sensor. Can be one of the following:online - the sensor has sent a report in the past hourintermittent - the sensor has not sent a report in the past houroffline - the sensor has not sent a report in the past 3 hoursasleep - the sensor is in a scheduled non-reporting state to save battery | String |
attributes.network.last_message_timestamp | Timestamp in UTC of last received sensor message. | String |
attributes.battery.status | Current battery health of the sensor. Can be one of the following:healthy - over 6 months estimated remaining lifereplace_soon - less than 6 months estimated remaining lifereplace_now - less than 2 months estimated remaining life | String |
relationships.building | The building that the sensor is located within. Building details included in the included top level response key. | Object |
relationships.floor | The floor that the sensor is installed on. Floor details included in the included top level response key. | Object |