get_sleep_periods
Fetch sleep periods by date range, returning bedtime, sleep-stage durations, awake time, latency, efficiency, heart rate, HRV, and readiness.
Instructions
Get detailed sleep periods: bedtime start and end, total, deep, REM and light sleep durations (seconds), awake time, latency, efficiency, average and lowest heart rate, average HRV, breathing rate, and the readiness computed from that sleep.
A day can have several periods. type 'long_sleep' is the main sleep; naps and short rests appear as 'sleep', 'late_nap' or 'rest'.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | No | Last day to include (inclusive), YYYY-MM-DD. Defaults to today. | |
| next_token | No | Continue a truncated result: pass the next_token from the previous response along with the same dates. | |
| start_date | No | First day to include, YYYY-MM-DD. Defaults to 6 days before end_date. | |
| include_time_series | No | Include the embedded time series (5 minute sleep phases, 30 second movement, per sample heart rate and HRV, MET samples). Off by default because they dominate the response size. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |