Skip to main content

Get effective observation ids for a device

MethodPath
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 project.

Behaviour​

  • deviceId is either the device identifier or the Device resource id (a UUID).
  • Each field is an Observation id, or null when no reading has set that value yet.
  • 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 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.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, or you lack Device:read.