Skip to main content

List live telemetry and alerts by device

MethodPath
GET/v1/slim/device/live/telemetry

Authentication · Access policies

Returns the telemetry and alerts for one page of live devices, keyed by device. Use it to poll the values on a page you already loaded with GET /v1/slim/device/live.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs search and read on Patient, Device, Location, Observation and Organization. Scope: the caller's project (from the token).

Behaviour​

  • Takes the same query parameters as GET /v1/slim/device/live and selects the same page of devices in the same order.
  • telemetry and alerts are keyed by the device identifier (for example Sleepiz/3001000), not by the Device resource id.
  • alerts has an entry for every device on the page. telemetry has an entry only for devices with telemetry.
  • total, page and count describe the page, as on /live.
  • Telemetry is read fresh on every request.
  • 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/device/live/telemetry?page=0&count=20' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Telemetry and alerts for one page of live devices.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack search or read on Patient, Device, Location, Observation or Organization, your session has no project, or you cannot access the project.
422A query parameter fails validation.