API Reference: Dashboard
The device dashboard represents the current, realtime status of all devices. Data is generally returned with the following values:
Timestamp:
- Last reported timestamp of the device.
- Reported in seconds since unix epoch (multiply by 1000 for milliseconds).
- As most devices report to the cloud every
15minutes, an offline device is generally considered to have a timestamp of31minutes ago.
Temperature:
- Temperature as reported by the device.
- Reported in °C
- For devices with removable / interchangeable temperature sensors (ICE Coolers, for example), a
nulltemperature value indicates the icepack has been removed. For all other devices this indicates a sensor read error.
Duration:
- Duration remaining until Excursion
- Reported in hours
Battery:
- Battery remaining, as a percent (out of 100).
/devices/dashboard
Get the current Dashboard status of multiple devices. A valid Cloud license on every included device is required for this endpoint.
| Method | Content Type | Response |
|---|---|---|
POST |
application/json |
JSON Object |
Request Example:
[
"<DEVICE-TYPE>_<SERIAL-NUMBER>",
"<DEVICE-TYPE>_<SERIAL-NUMBER>",
"APRU-006L_0002356",
"ICE-002L_51234D",
...
]
For example, a cURL request would be:
curl -H "Authorization: Bearer <ORGANIZATION_API_KEY>"
--H "Content-Type: application/json"
--request POST
--data '["APRU-006L_0002356", "ICE-002L_51234D"]'
https://api.blood.dev/devices/dashboard/
Response, as a JSON array of devices:
| Method | Description | Units |
|---|---|---|
temperature |
Current Cooler Temperature | °C |
duration |
Duration remaining until Excursion | hours |
timestamp |
Last recorded timestamp | seconds |
battery |
Current battery percentage | % |
{
"<DEVICE_TYPE>_<SERIAL_NUMBER>":{
"temperature": <float>,
"duration": <int>,
"timestamp": <int>,
"battery": <int>,
},
"APRU-006L_0002356":{
"temperature": 4.2,
"duration": 26,
"timestamp": 1738367977,
"battery": 82,
},
...
}
/devices/dashboard/<DEVICE_TYPE>/<SERIAL_NUMBER>
Get the current Dashboard status of a given device. A valid Cloud license on this device is required for this endpoint.
| Method | Description | Response |
|---|---|---|
GET |
Returns a single device's status | JSON Object |
Response:
| Method | Description | Units |
|---|---|---|
temperature |
Current Cooler Temperature | °C |
duration |
Duration remaining until Excursion | hours |
timestamp |
Last recorded timestamp | seconds |
battery |
Current battery percentage | % |
{
"temperature": <float>,
"duration": <int>,
"timestamp": <int>,
"battery": <int>,
}