Skip to main content

List telemetry and alerts (compatibility)

MethodPath
GET/v1/slim/query/telemetry

Authentication · Access policies

Compatibility route for older live polling clients. Returns telemetry and alerts maps keyed by device identifier. For new integrations, use GET /v1/slim/device/live/telemetry.

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). The project parameter is ignored.

Behaviour​

  • Takes the same query parameters as GET /v1/slim/query, with the same validation rules.
  • Returns total, plus telemetry and alerts for the requested page only.
  • alerts has an entry for every device on the page. telemetry has an entry only for devices with telemetry.
  • 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/query/telemetry?mustInclude=device,telemetry&shouldInclude=device,telemetry' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Telemetry and alerts retrieved successfully.

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.