Sleep
Stream: session | Event type: sleep
A sleep period with duration, sleep stage breakdown, and overnight biometrics.
Example
Section titled “Example”{ "event_type": "sleep", "data_version": "1.1", "source_id": "b2c3d4e5...", "provider_ref": "67890", "device_id": "dev-001", "payload_ts": 1742504100000, "revision": 1, "capture_mode": null, "start_time": 1742504100000, "end_time": 1742531100000, "duration_s": 27000, "stages": { "awake_s": 1800, "light_s": 10800, "deep_s": 7200, "rem_s": 7200 }, "efficiency_pct": 92, "heart_rate_avg_bpm": 58, "spo2_avg_pct": 96.5, "respiratory_rate_avg": 14.2}Fields
Section titled “Fields”| Field | Type | Unit | Description |
|---|---|---|---|
start_time | number | null | epoch ms | Sleep start time. |
end_time | number | null | epoch ms | Sleep end time. |
duration_s | number | null | seconds | Total sleep duration. |
stages | object | null | — | Sleep stage breakdown. |
stages.awake_s | number | null | seconds | Time spent awake. |
stages.light_s | number | null | seconds | Time in light sleep. |
stages.deep_s | number | null | seconds | Time in deep sleep. |
stages.rem_s | number | null | seconds | Time in REM sleep. |
efficiency_pct | number | null | percent | Sleep efficiency (time asleep / time in bed). |
heart_rate_avg_bpm | number | null | bpm | Average heart rate during sleep. |
spo2_avg_pct | number | null | percent | Average blood oxygen saturation. |
respiratory_rate_avg | number | null | breaths/min | Average respiratory rate. |