OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
SlimSlim/Telemetry

Get last-received observation ids for a device

  • Sandbox: available
  • Staging: available
  • Production: unknown
GET
/v1/slim/telemetry/{deviceId}/lastIds

Returns, for one device, the ids of the most recent Observations received for heart rate, respiratory rate, sleep status and presence, plus the latest batch. Unlike effectiveIds, these change on every reading, whether or not the displayed value changed.

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 nothing has been received for it 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/c3499c27-2973-0a7f-807e-fb8676a92dcb/lastIds' \  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'

Authorization

bearer
headerAuthorizationBearer <JWT>

Path Parameters

deviceId*string

Device identifier (for example Sleepiz/3001000) or Device resource id (UUID).

Length1 <= length

Response Body

Last-received observation ids for the device.

application/json
  1. response
heartRate*string
respiratoryRate*string
sleepStatus*string
presenceStatus*string
batch*string
Example Request
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/string/lastIds'
Example Response
{  "heartRate": "string",  "respiratoryRate": "string",  "sleepStatus": "string",  "presenceStatus": "string",  "batch": "string"}

Get effective observation ids for a device GET

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 ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/c3499c27-2973-0a7f-807e-fb8676a92dcb/effectiveIds' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```

Get device telemetry and alerts GET

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 ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```