List effective observation ids by device
- Sandbox: available
- Staging: available
- Production: unknown
Returns the effective Observation ids for every device in your project, keyed by device identifier. These are the readings that produced each device's current heart rate, respiratory rate, sleep status and presence values.
Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:read and Device:search.
Scope: the caller's project (from the token).
Behaviour
- Covers the devices that have telemetry, up to the first 1000 devices of the project, including devices without a resident.
- Each value has the same shape as
GET /v1/slim/telemetry/{deviceId}/effectiveIds. Fields arenullwhen no reading has set them.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/effectiveIds' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk'bearerAuthorizationBearer <JWT>Effective observation ids, keyed by device identifier.
application/json- response
[key: string]?curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/effectiveIds'{ "property1": { "heartRate": "string", "respiratoryRate": "string", "sleepStatus": "string", "presenceStatus": "string" }, "property2": { "heartRate": "string", "respiratoryRate": "string", "sleepStatus": "string", "presenceStatus": "string" }}Get sleep statistics GET
Returns a resident's sleep statistics for one night, grouped by device, with each metric compared against the average of the preceding nights. Use it for the sleep detail view. **Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Observation:read` and `Observation:search`. **Scope:** the caller's project (from the token). Sleep data is read with your token, so Medplum's access policy limits what you see. ## Behaviour - The "night" is the calendar day, in the project's time zone, of `endDate`. A sleep recording belongs to the day its `effectivePeriod.end` falls on. - `lastDayCount` is how many earlier days feed `average`. It defaults to `7` and must be between 1 and 30. - Each device entry holds, per metric, `current` (the night of `endDate`), `average` (over the earlier nights that have a recording) and `diff`. A device with no recording for the night of `endDate` is left out. - When one night has several recordings, the one written last is used: the latest `meta.lastUpdated`. Its period and completeness do not count, so a shorter recording written later wins, and so can a same-day nap ending after the night. A metric it does not carry is `null`, never taken from another recording. The PDF export's sleep table uses the same rule, and so do the `GET /v1/slim/trends/graphs` charts where they can match a night's readings to its recordings. - `average` and `diff` use each earlier night's latest-written recording the same way. - Only recordings that end inside one of the resident's use periods of their device are counted, before a night's recording is picked. So a previous resident's night that ended before the device was handed over, but reached Ovok after it and was stored under this resident, is not shown. A resident with no device use history has all recordings counted. The PDF export and the `GET /v1/slim/trends/graphs` charts apply the same filter. - Once a resident has any use period, recordings of a device with no period of theirs, and those from before a device's earliest period, are not counted. A device assigned before use periods were recorded gets its first one on its next edit in Ovok, starting at the Device's last write before that edit. Each device whose recordings in a request all drop is counted in the `sleep.device_use_device_dropped` metric and logged at most once a minute. - Ovok reads the `sleep-stats` observations first and falls back to the LOINC pair `93832-4` (sleep duration) and `103216-8` (out-of-bed count) when there are none. - The response is `{}` when no qualifying recording exists. - Results are cached for up to 60 seconds per project, resident, `endDate` and `lastDayCount`. A write to the resident's data invalidates the cache sooner. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/sleep/statistics?patientId=c3499c27-2973-0a7f-807e-fb8676a92dcb&endDate=2026-09-28T00:00:00Z&lastDayCount=7' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```
List last-received observation ids by device GET
Returns the last-received Observation ids for every device in your project, keyed by device identifier. **Auth:** bearer token. The caller must be a practitioner, an admin or a System Owner, and needs `Device:read` and `Device:search`. **Scope:** the caller's project (from the token). ## Behaviour - Covers the devices that have telemetry, up to the first 1000 devices of the project, including devices without a resident. - Each value has the same shape as `GET /v1/slim/telemetry/{deviceId}/lastIds`. Fields are `null` when nothing has been received for them. ## Example ```bash curl -X GET 'https://api.sandbox.ovok.com/v1/slim/telemetry/lastIds' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```