Telemetry
Get device telemetry and alerts
Get device telemetry and alerts using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/telemetry/:deviceId |
Authentication · Access policies
Returns the current telemetry and alerts for one device. Use it to poll the resident detail view.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:read.
Scope: the caller's project and its sub-projects (from the token). Only devices in that scope are found.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deviceId | string | Yes | Device identifier (for example Demo/3001000) or Device resource id (UUID). Encode the / of an identifier as %2F. |
Behaviour
deviceIdis either the device identifier (for exampleDemo/3001000) or the Device resource id (a UUID). A UUID is resolved to the identifier.- The response
deviceIdis the identifier the telemetry is keyed by. telemetryandalertshave the same shape as one entry ofGET /v1/slim/device/live/telemetry.- The device is looked up among all devices of your project and its sub-projects, including devices without a resident.
- A UUID resolves only for a device in your own project. A device of a sub-project is found by its identifier.
- Telemetry is read fresh on every request. The device structure is cached and refreshed when you write through the Slim routes.
- The route returns 503 when the server is at capacity for live reads or the device list cannot be built. Retry shortly.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — Current telemetry and alerts for the device.
{
"deviceId": "Demo/3001000",
"telemetry": {
"active": { "value": true, "ts": 1790581330000 },
"effectiveHeartRate": { "value": 128, "ts": 1790581315000 },
"effectiveRespiratoryRate": { "value": 14, "ts": 1790581315000 },
"effectiveSleepStatus": { "value": "asleep", "ts": 1790581270000 },
"lastMeasurementTime": { "value": "2026-09-28T07:42:10.000Z", "ts": 1790581330000 },
"lastActivityTime": { "value": "2026-09-28T07:42:10.000Z", "ts": 1790581330000 },
"name": { "value": "Demo/3001000", "ts": null },
"effectiveOxygenSaturation": { "value": null, "ts": null },
"effectivePulseRate": { "value": null, "ts": null },
"effectiveSystolicBloodPressure": { "value": null, "ts": null },
"effectiveDiastolicBloodPressure": { "value": null, "ts": null },
"effectiveHeartRateVariability": { "value": null, "ts": null },
"effectivePerfusionIndex": { "value": null, "ts": null },
"effectiveBodyTemperature": { "value": null, "ts": null }
},
"alerts": {
"heartRate": {
"alert": true,
"value": { "measuredValue": 128, "level": "high", "color": "#E5254B" },
"message": { "signals": { "op": "gt", "threshold": 120, "bound": "max" } },
"communicationRequestId": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b30",
"observationId": null,
"color": "#E5254B",
"state": "alert",
"updatedAt": "2026-09-28T07:41:55.000Z"
},
"respiratoryRate": {
"alert": false,
"value": null,
"message": null,
"communicationRequestId": null,
"observationId": null,
"color": null,
"state": "normal",
"updatedAt": null
},
"outOfBed": null
}
}| Field | Type | Description |
|---|---|---|
deviceId | string | Device identifier the telemetry is keyed by, for example Demo/3001000. |
telemetry | object | Current telemetry of the device. Each metric below is an object with value and ts. |
telemetry.active.value | boolean | true while the device is connected. false when the device is marked lost or has sent nothing for more than 10 minutes. |
telemetry.active.ts | integer | null | Time of the last activity, in Unix milliseconds. |
telemetry.effectiveHeartRate.value | number | null | Current heart rate in beats per minute, rounded to one decimal. null when the resident is not present in bed or no current reading exists. |
telemetry.effectiveHeartRate.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveRespiratoryRate.value | number | null | Current respiratory rate in breaths per minute, rounded to one decimal. null when the resident is not present in bed or no current reading exists. |
telemetry.effectiveRespiratoryRate.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveSleepStatus.value | "disconnected" | "connected" | "away" | "asleep" | "awake" | null | Current sleep status. disconnected when the device is inactive. connected when the device is online but presence is unknown. away when the resident is out of bed. asleep or awake when the resident is in bed. |
telemetry.effectiveSleepStatus.ts | integer | null | Time the status was set, in Unix milliseconds. For away it is the time the resident left the bed. |
telemetry.lastMeasurementTime.value | string (ISO 8601 date-time) | Time of the latest reading from the device. |
telemetry.lastMeasurementTime.ts | integer | null | Same time in Unix milliseconds. null when no time is known. |
telemetry.lastActivityTime.value | string (ISO 8601 date-time) | Time of the last activity of the device. |
telemetry.lastActivityTime.ts | integer | null | Same time in Unix milliseconds. |
telemetry.name.value | string | Device name. |
telemetry.name.ts | null | Always null. |
telemetry.effectiveOxygenSaturation.value | number | null | Oxygen saturation in percent. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectiveOxygenSaturation.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectivePulseRate.value | number | null | Pulse rate from pulse oximetry, in beats per minute. It is separate from effectiveHeartRate. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectivePulseRate.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveSystolicBloodPressure.value | number | null | Systolic blood pressure in mmHg. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectiveSystolicBloodPressure.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveDiastolicBloodPressure.value | number | null | Diastolic blood pressure in mmHg. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectiveDiastolicBloodPressure.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveHeartRateVariability.value | number | null | Heart rate variability, in the unit the device reports. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectiveHeartRateVariability.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectivePerfusionIndex.value | number | null | Perfusion index, in the unit the device reports. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectivePerfusionIndex.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
telemetry.effectiveBodyTemperature.value | number | null | Body temperature in degrees Celsius. null until the device reports it, and while the resident is not present in bed. |
telemetry.effectiveBodyTemperature.ts | integer | null | Start of the measurement window, in Unix milliseconds. null when value is null. |
alerts | object | Alerts for the device. Every key is always present. |
alerts.heartRate | object | Heart rate alert of the resident. |
alerts.heartRate.alert | boolean | true while an alert is open for the resident and the current reading still breaches it. |
alerts.heartRate.state | "alert" | "normal" | alert when alert is true, otherwise normal. |
alerts.heartRate.color | string | null | Display colour as a hex string, for example #E5254B. null when there is no alert. |
alerts.heartRate.value | object | null | Alert details from Signals. null when there is no alert. The keys below are the ones set today. |
alerts.heartRate.value.measuredValue | number | The reading that breached the limit. |
alerts.heartRate.value.level | "high" | "low" | null | Whether the reading is above (high) or below (low) the limit. null when unknown. |
alerts.heartRate.value.color | string | Alert colour as a hex string. |
alerts.heartRate.value.episodeId | string | Id of the open Signals episode. Present only for an alert that comes from an episode. |
alerts.heartRate.message | object | null | The limit that was crossed. null when there is no alert, and for an alert from a Signals episode. |
alerts.heartRate.message.signals | object | The rule that fired. |
alerts.heartRate.message.signals.op | "gt" | "lt" | gt when the alert fires above the limit, lt when it fires below it. |
alerts.heartRate.message.signals.threshold | number | The limit that was crossed, for example 120. |
alerts.heartRate.message.signals.bound | "max" | "min" | max when the limit is the upper bound of the range, min when it is the lower bound. |
alerts.heartRate.communicationRequestId | string | null | Id of the alert notification. It can stay set after the alert clears. null when there is none, and for an alert from a Signals episode. |
alerts.heartRate.observationId | string | null | Reserved. Always null today. |
alerts.heartRate.updatedAt | string (ISO 8601 date-time) | null | Time the alert was last updated. |
alerts.respiratoryRate | object | Respiratory rate alert of the resident. |
alerts.respiratoryRate.alert | boolean | true while an alert is open for the resident and the current reading still breaches it. |
alerts.respiratoryRate.state | "alert" | "normal" | alert when alert is true, otherwise normal. |
alerts.respiratoryRate.color | string | null | Display colour as a hex string, for example #E5254B. null when there is no alert. |
alerts.respiratoryRate.value | object | null | Alert details from Signals. null when there is no alert. The keys below are the ones set today. |
alerts.respiratoryRate.value.measuredValue | number | The reading that breached the limit. |
alerts.respiratoryRate.value.level | "high" | "low" | null | Whether the reading is above (high) or below (low) the limit. null when unknown. |
alerts.respiratoryRate.value.color | string | Alert colour as a hex string. |
alerts.respiratoryRate.value.episodeId | string | Id of the open Signals episode. Present only for an alert that comes from an episode. |
alerts.respiratoryRate.message | object | null | The limit that was crossed. null when there is no alert, and for an alert from a Signals episode. |
alerts.respiratoryRate.message.signals | object | The rule that fired. |
alerts.respiratoryRate.message.signals.op | "gt" | "lt" | gt when the alert fires above the limit, lt when it fires below it. |
alerts.respiratoryRate.message.signals.threshold | number | The limit that was crossed, for example 24. |
alerts.respiratoryRate.message.signals.bound | "max" | "min" | max when the limit is the upper bound of the range, min when it is the lower bound. |
alerts.respiratoryRate.communicationRequestId | string | null | Id of the alert notification. It can stay set after the alert clears. null when there is none, and for an alert from a Signals episode. |
alerts.respiratoryRate.observationId | string | null | Reserved. Always null today. |
alerts.respiratoryRate.updatedAt | string (ISO 8601 date-time) | null | Time the alert was last updated. |
alerts.outOfBed | object | null | The resident's open out-of-bed episode, or null when there is none. |
alerts.outOfBed.outOfBed | boolean | Always true when the object is present. |
alerts.outOfBed.communicationRequestId | string | Id of the out-of-bed notification. |
alerts.outOfBed.sinceTime | string (ISO 8601 date-time) | Time the resident left the bed. It stays the same while the episode lasts. |
Errors
| Status | Meaning |
|---|---|
401 | Bearer token is missing, invalid or expired. |
403 | You are not a practitioner, admin or System Owner, you lack Device:read, your session has no project, or you cannot access the project. |
404 | No telemetry or alerts exist for this device in your project. |
503 | The server is at capacity for live reads (the body has error: "live_reads_over_capacity" (live_reads_over_capacity) and retryAfterSec, and the Retry-After header is set), the device list cannot be built right now (no Retry-After), or the access policy cannot be read. Retry shortly. |
Last updated on