# List live telemetry and alerts by device

Canonical page: https://docs.ovok.com/slim-apis/device/list-live-telemetry-and-alerts-by-device

| Method | Path |
| --- | --- |
| `GET` | `/v1/slim/device/live/telemetry` |

[Authentication](/authentication) · [Access policies](/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).

## Request [#request]

### Query parameters [#query-parameters]

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `page` | `integer` | No | Zero-based page number. Default `0`, minimum `0`. |
| `count` | `integer` | No | Rows per page. Default `20`, minimum `1`, maximum `100`. |
| `sortBy` | `"locationName"` \| `"patientName"` \| `"patientNickname"` \| `"organizationName"` \| `"effectiveHeartRate"` \| `"effectiveRespiratoryRate"` \| `"effectiveSleepStatus"` \| `"admissionDate"` \| `"dischargeDate"` | No | Sort column. Default `locationName`. |
| `orderBy` | `"ASC"` \| `"DESC"` | No | Sort direction. Upper case only. Default `ASC`. |
| `search` | `string` | No | Fuzzy match on resident nickname and name, location name, zone name, and device name, identifier and serial. Trimmed, at least 1 character. |
| `deviceId` | `string` | No | Keep only this device, matched against the device identifier. |
| `organizationId` | `string` | No | A zone id, `assigned` or `unassigned`. A zone id also matches devices in its child zones. |
| `effectiveSleepStatus` | `"disconnected"` \| `"connected"` \| `"awake"` \| `"away"` \| `"asleep"` | No | Keep devices in this sleep status. |
| `residentState` | `"active"` \| `"discharged-recent"` \| `"discharged"` \| `"archived"` | No | Accepted and ignored. |
| `includeUnassigned` | `boolean` | No | `true` also returns devices without a resident. Any other value is `false`. Default `false`. |

## Behaviour [#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 [#example]

```bash
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/device/live/telemetry?page=0&count=20' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"
```

## Successful response [#successful-response]

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

```json
{
  "total": 1,
  "page": 0,
  "count": 20,
  "telemetry": {
    "Demo/1000001": {
      "active": { "value": true, "ts": 1790000000000 },
      "effectiveHeartRate": { "value": 62, "ts": 1789999400000 },
      "effectiveRespiratoryRate": { "value": 14, "ts": 1789999400000 },
      "effectiveSleepStatus": { "value": "asleep", "ts": 1789998000000 },
      "lastMeasurementTime": { "value": "2026-10-09T08:50:00.000Z", "ts": 1789999800000 },
      "lastActivityTime": { "value": "2026-10-09T08:53:20.000Z", "ts": 1790000000000 },
      "name": { "value": "Demo/1000001", "ts": null },
      "effectiveOxygenSaturation": { "value": 97, "ts": 1789999400000 },
      "effectivePulseRate": { "value": null, "ts": null },
      "effectiveSystolicBloodPressure": { "value": null, "ts": null },
      "effectiveDiastolicBloodPressure": { "value": null, "ts": null },
      "effectiveHeartRateVariability": { "value": null, "ts": null },
      "effectivePerfusionIndex": { "value": null, "ts": null },
      "effectiveBodyTemperature": { "value": null, "ts": null }
    }
  },
  "alerts": {
    "Demo/1000001": {
      "heartRate": { "alert": false, "value": null, "message": null, "communicationRequestId": null, "observationId": null, "color": null, "state": "normal", "updatedAt": null },
      "respiratoryRate": { "alert": false, "value": null, "message": null, "communicationRequestId": null, "observationId": null, "color": null, "state": "normal", "updatedAt": null },
      "outOfBed": null
    }
  }
}
```

| Field | Type | Description |
| --- | --- | --- |
| `total` | `integer` | Number of devices after filtering, across all pages. |
| `page` | `integer` | Page number of this response. |
| `count` | `integer` | Page size of this response. |
| `telemetry` | `object` | Telemetry keyed by device identifier. A device with no telemetry has no entry. |
| `telemetry.<identifier>` | `object` | Latest live telemetry of the device. Every metric in it is an object with `value` and `ts`. |
| `telemetry.<identifier>.<metric>.ts` | `integer \| null` | Time of the value in epoch milliseconds. |
| `telemetry.<identifier>.active` | `object` | `value` is `true` when the device is connected. A device with no activity for 10 minutes is `false`. |
| `telemetry.<identifier>.effectiveHeartRate` | `object` | `value` is the heart rate in beats per minute with one decimal, or `null` when no resident is in bed or there is no reading. |
| `telemetry.<identifier>.effectiveRespiratoryRate` | `object` | `value` is the respiratory rate in breaths per minute with one decimal, or `null`. |
| `telemetry.<identifier>.effectiveSleepStatus` | `object` | `value` is `"asleep"`, `"awake"`, `"away"`, `"connected"` or `"disconnected"`. |
| `telemetry.<identifier>.lastMeasurementTime` | `object` | `value` is an ISO 8601 time string. |
| `telemetry.<identifier>.lastActivityTime` | `object` | `value` is an ISO 8601 time string. |
| `telemetry.<identifier>.name` | `object` | `value` is the device name. `ts` is `null`. |
| `telemetry.<identifier>.effectiveOxygenSaturation` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectivePulseRate` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectiveSystolicBloodPressure` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectiveDiastolicBloodPressure` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectiveHeartRateVariability` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectivePerfusionIndex` | `object` | `value` is a number or `null`. |
| `telemetry.<identifier>.effectiveBodyTemperature` | `object` | `value` is a number in degrees Celsius or `null`. |
| `alerts` | `object` | Alerts keyed by device identifier. Every device on the page has an entry. |
| `alerts.<identifier>` | `object` | Current alerts of the resident on the device. |
| `alerts.<identifier>.heartRate` | `object` | Heart rate alert. |
| `alerts.<identifier>.heartRate.alert` | `boolean` | `true` while the alert is active. |
| `alerts.<identifier>.heartRate.state` | `"alert"` \| `"normal"` | `alert` while the alert is active, otherwise `normal`. |
| `alerts.<identifier>.heartRate.color` | `string \| null` | Alert color. `null` when there is no alert. |
| `alerts.<identifier>.heartRate.value` | `object \| null` | Alert details as recorded by Signals. `null` when there is no alert. |
| `alerts.<identifier>.heartRate.message` | `object \| null` | Alert message as recorded by Signals. `null` when there is no alert. |
| `alerts.<identifier>.heartRate.communicationRequestId` | `string \| null` | Id of the alert's CommunicationRequest. |
| `alerts.<identifier>.heartRate.observationId` | `string \| null` | Id of the Observation that raised the alert. |
| `alerts.<identifier>.heartRate.updatedAt` | `string \| null` | When the alert last changed. |
| `alerts.<identifier>.respiratoryRate` | `object` | Respiratory rate alert, with the same fields as `alerts.<identifier>.heartRate`. |
| `alerts.<identifier>.outOfBed` | `object \| null` | The active out-of-bed episode of the resident. `null` when there is none or an open episode has no start time. |
| `alerts.<identifier>.outOfBed.outOfBed` | `true` | Always `true`. |
| `alerts.<identifier>.outOfBed.communicationRequestId` | `string` | Id of the Signals episode. |
| `alerts.<identifier>.outOfBed.sinceTime` | `string` | When the resident left the bed, as an ISO 8601 time string. |

## Errors [#errors]

| Status | Meaning |
| --- | --- |
| [`401`](/errors/unauthenticated) | Bearer token is missing, invalid or expired. |
| [`403`](/errors/forbidden) | You 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. |
| [`422`](/errors/validation-failed) | A query parameter fails validation. |
| [`503`](/errors/service-unavailable) | The server is at capacity for live reads, or the device list cannot be built and no earlier complete list exists. Retry after the number of seconds in the `Retry-After` header. |
