Per-Node Status details

GET {baseURl}/v2/devices/nodes/:nodeId/status
Detailed Status for a single node.

Example
https://clarity-data-api.clarity.io/v2/devices/nodes/A0000001/status?org=myorgVD43

Headers

• x-api-key: the API key string.

Request

path parameter		description
nodeId	string	The target node ID (marked on the physical device). Example "A0000001"

query parameter		description
org	string required	The ID of the organization. Find it under the user profile section in Dashboard. Example "myorgVD43"

Response

The response for this endpoint is organized by the following sections:

attribute		description
summary	string	The general status of the node. One of: healthy, needs attention, or offline.
activity	object	Information about reading activity over time. See Activity.
behavior	object	Node-informed behavior. See Behavior.
operational	object	Operational status information about the node. See Operational.

Activity

attribute		description
summary	string	ALARMS if there's any alarms, OK otherwise.
online	string	Node's connectivity status. Either online or offline.
receivedHistogram	array	An array of number that counts readings received over the last 48 hours in 1-hour bins. The array index indicates the hour, the value the count. Example: If the response was received at "2022-01-01T12:44Z", receivedHistogram[0] contains the count of readings received between 12:00 and 12:44, receivedHistogram[1] contains the count of readings received between 11:00 and 11:59, receivedHistogram[2] contains the count of readings received between 10:00 and 10:59, etc.
lastReadingReceivedAt	string	The ISO 8601 time when the last reading was uploaded and marked as received.

Histogram

attribute		description
buckets	array	An array of number that counts readings received over the last 48 hours in 1-hour bins.
startOfOldestBucket	string	The ISO 8601 time for the first bucket (index zero).
endOfMostRecentBucket	string	The ISO 8601 time for the last bucket (index length - 1). Note: not to be confused with lastReadingReceivedAt.

Behavior

attribute		description
nextSleepPeriod	number	The number of seconds that the node will sleep before starting the next sample. If battery recovery mode is enabled, nextSleepPeriod can be longer than the configured sleep time.
nextSleepMultiplier	number	The factor that the node will multiply the configured sleep time by to calculate nextSleepPeriod. If battery recovery mode is enabled, the node can progressively increase nextSleepMultiplier in reaction to low power situations.

Operational

attribute		description
summary	string	ALARMS if any alarm is active, otherwise OK.
accessoryModules	object	Currently paired modules status summary. See Accessory Module.
communication	object	Grouping of communication-related status. See Communication.
internalSensors	object	Internal sensors health status. See Internal Sensors.
power	object	Grouping of power-related status. See Power.

Accessory Module

attribute		description
summary	string	ALARMS if there's any alarms, OK otherwise.
accessorySensed	boolean	True if at least one reading was detected from the module.

Communication

attribute		description
summary	string	ALARMS if any alarm is active, otherwise OK.
signalStrength	object	Composed of two fields: signalLevel (string code that discretizes signal strengths into 5 levels) and signalRssi (a number that represents the sensed radio power level).

Signal Levels

• 1-marginal
• 2-ok
• 3-good
• 4-excellent
• unknown

Internal Sensors

attribute		description
summary	string	ALARMS if any internal sensor has an alarm, otherwise OK.
perSensorType	array	Array of objects with the following fields: sensorType (one of PM, NO2 or RHT) and summary (one of: ALARMS, OK, or unknown).

Power

attribute		description
summary	string	ALARMS if any alarm is active, otherwise OK.
battery	object	Describes the battery status. See Battery below.
source	string	One of: "power adapter", "solar panel", or "unknown". Example "power adapter".

Battery

attribute		description
percent	number	The battery level as a percentage.
recoveryMode	boolean	Indicates whether the device entered a state of reduce sampling frequency to conserve battery power.
voltage	number	Current battery voltage.
chargingStatus	string	One of: "charging", "discharging normally", "cannot charge".
temperature	string	Indicate operation state due to temperature. One of: "normal", "too hot to charge", or "too cold to charge".

Example 200 Response

{
    "summary": "offline",
    "activity": {
        "summary": "ALARMS",
        "onlineStatus": "offline",
        "receivedHistogram": {
            "buckets": [
                0,
                0,
                …,
                0
            ],
            "startOfOldestBucket": "2022-08-30T19:00:00.000Z",
            "endOfMostRecentBucket": "2022-09-01T18:19:55.353Z"
        },
        "lastReadingReceivedAt": "2022-08-31T05:01:49.543Z"
    },
    "operational": {
        "summary": "OK",
        "communication": {
            "summary": "OK",
            "signalStrength": {
                "signalRssi": -91,
                "signalLevel": "2-ok"
            }
        },
        "power": {
            "summary": "OK",
            "battery": {
                "percent": 0.1,
                "recoveryMode": false,
                "voltage": 0,
                "chargingStatus": "cannot charge",
                "temperature": "normal",
            },
            "source": "power adapter"
        },
        "internalSensors": {
            "summary": "OK",
            "perSensorType": [
                {
                    "sensorType": "PM",
                    "summary": "OK"
                },
                {
                    "sensorType": "NO2",
                    "summary": "OK"
                },
                {
                    "sensorType": "RHT",
                    "summary": "OK"
                }
            ]
        },
        "accessoryModules": {
            "summary": "OK",
            "accessorySensed": false
        }
    },
    "behavior": {
        "nextSleepPeriod": 1800,
        "nextSleepMultiplier": 2
    }
}