Skip to content

Sleep

Stream: session | Event type: sleep

A sleep period with duration, sleep stage breakdown, and overnight biometrics.

{
"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
}
FieldTypeUnitDescription
start_timenumber | nullepoch msSleep start time.
end_timenumber | nullepoch msSleep end time.
duration_snumber | nullsecondsTotal sleep duration.
stagesobject | nullSleep stage breakdown.
stages.awake_snumber | nullsecondsTime spent awake.
stages.light_snumber | nullsecondsTime in light sleep.
stages.deep_snumber | nullsecondsTime in deep sleep.
stages.rem_snumber | nullsecondsTime in REM sleep.
efficiency_pctnumber | nullpercentSleep efficiency (time asleep / time in bed).
heart_rate_avg_bpmnumber | nullbpmAverage heart rate during sleep.
spo2_avg_pctnumber | nullpercentAverage blood oxygen saturation.
respiratory_rate_avgnumber | nullbreaths/minAverage respiratory rate.