Get sleep period
get_sleep_periodRetrieve full details for one sleep period by its sleep_id: hypnogram, heart-rate and HRV curves, and readiness contributors. Get the id from list_sleep_periods or get_daily_overview first.
Instructions
Get one sleep period in full detail by its sleep_id: the same summary as list_sleep_periods plus a hypnogram (deep/light/REM/awake segments at 5-minute resolution, in local time), heart-rate and HRV curves through the night (downsampled to at most 120 points, with avg/min/max), and the readiness contributors it produced. Use it to explain one specific night; get the id from list_sleep_periods or get_daily_overview first. An unknown id returns a 404 error; raw: true returns Oura's original object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Return Oura's raw API objects instead of compact summaries with friendly units. | |
| sleep_id | Yes | Sleep period id (from list_sleep_periods or get_daily_overview). |