Skip to main content

Get device telemetry and alerts

MethodPath
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 (from the token). Only devices in that project are found.

Behaviour​

  • deviceId is either the device identifier (for example Sleepiz/3001000) or the Device resource id (a UUID). A UUID is resolved to the identifier.
  • The response deviceId is the identifier the telemetry is keyed by.
  • telemetry and alerts have the same shape as one entry of GET /v1/slim/device/live/telemetry.
  • The device is looked up among the first 1000 devices of your project, including devices without a resident.
  • Telemetry is read fresh on every request.

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.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Device:read, your session has no project, or you cannot access the project.
404No telemetry or alerts exist for this device in your project.