Understand Health

Health is an important concept for understanding the status of your sensor fleet and the availability of your data.

Health is broken into two categories, Sensor Health and Space Health. Sensor Health is the status of the actual hardware (aka the sensor). Space Health is the status of a user-defined area (eg: meeting room, kitchen). It’s possible that one space will include more than 1 sensor.

Sensor Health

Use the Sensors endpoint to query sensor metadata and its location. Use the Sensor Health endpoint to query the current health status of sensors in your fleet and how long they have been in that state.

Note: The Sensors endpoint response provides the location, not necessarily the spaces measured by this sensor.

Sensor Health Statuses

The following defines the different options for the health_status field returned in the Sensor Health endpoint.

  • healthy : The sensor is online and sending data.
  • degraded : The sensor is online but is not sending data. Coming soon, these devices will be marked as offline now.
  • offline : The sensor is offline and is not sending data.
  • unknown : The sensor's status is unknown. These are sensors without an AWS IOT certificate. We are working on making this feature available to all customers, and support will reach out if any action from the customer is needed. Use sensor health from our legacy API: https://docs.density.io/v2/#sensors-list if your sensors are showing unknown status.

Space Health

In Health Aware Presence and Current Occupancy endpoints, we provide the space_health_status along with the metric to provide full context on the reliability of live data.

Space Health Statuses

The following defines the different options for the space_health_status field returned in the Health Aware Presence and Current Occupancy endpoints.

  • healthy : All sensors in this space are healthy .
  • degraded : 1 or more sensor is degraded , offline or unknown .
  • offline : All sensors in this space are offline .
  • unknown : 1 or more sensors are unknown and no sensors are healthy . This could also be a case where a space has no sensors.
    • Example: healthy and unknown → degraded
    • Example: offline and unknown → unknown

How to interpret the data

  • Spaces with a space_health_status of healthy can be trusted for accurate insights.
  • Exercise caution when relying on data from spaces with a degraded status, as it may not be entirely comprehensive. You may check the sensor status endpoint to see when devices fell offline or came back to healthy.
  • It is best practice to ignore real-time data from spaces that are offline or unknown .