Telemetry
Get effective observation ids for a device
Get effective observation ids for a device using Ovok’s Slim API.
| Method | Path |
|---|---|
GET | /v1/slim/telemetry/:deviceId/effectiveIds |
Authentication · Access policies
Returns, for one device, the ids of the Observations that produced its current heart rate, respiratory rate, sleep status and presence values. Use it to trace a displayed value back to its source reading.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:read.
Scope: a device identifier only resolves when the device is visible to your token and in the caller's own project (sub-projects are not included).
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 or the Device resource id (a UUID).- Each field is an Observation id, or
nullwhen no reading has set that value yet. - When a reading clears a value, the id of that clearing reading is kept.
- Only devices whose readings carry their own Observation id fill these fields. For other devices every field is
null. - A device that is not found, or not in your project, returns every field
null, not an error. - Lookups of a device are cached for up to 10 minutes, and misses for 30 seconds.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21/effectiveIds' \
-H "Authorization: Bearer ${OVOK_TOKEN}"Successful response
200 — Effective observation ids for the device.
{
"heartRate": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b41",
"respiratoryRate": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b42",
"sleepStatus": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b43",
"presenceStatus": "3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b44"
}| Field | Type | Description |
|---|---|---|
heartRate | string | null | Id of the Observation that produced the current heart rate. null when none has been recorded yet. |
respiratoryRate | string | null | Id of the Observation that produced the current respiratory rate. null when none has been recorded yet. |
sleepStatus | string | null | Id of the Observation that produced the current sleep status. null when none has been recorded yet. |
presenceStatus | string | null | Id of the Observation that produced the current presence status. null when none has been recorded yet. |
Errors
Last updated on