Sleep summaries
get_sleep_summariesRetrieve night-by-night sleep summaries for a date range, including stages, score, heart rate, stress, respiration, SpO2, sleep need, and Garmin insights.
Instructions
Night-by-night sleep over a range, one compact row per night filed under the date the user woke up: start/end in local time; hours of sleep, deep, light, REM and awake (and naps); sleep score with its quality and factor ratings; average HR, stress and respiration (avg/low/high); SpO2 average/lowest; sleep need vs baseline in minutes with what drove it (training load, e.g. HIGH_ACWR_AND_CHRONIC, HRV, sleep history, naps) and next night's need; Garmin's insights. For last night alone use get_readiness or get_sleep; for trends over weeks or months use summarize_wellness. Up to 92 days per call: pass a period (e.g. last_7_days, last_30_days, this_month) or start_date/end_date. detail='full' returns Garmin's raw records.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| detail | No | compact (default) keeps the meaningful fields in readable units; full returns Garmin's raw payload. | compact |
| period | No | Named period resolved in the user's time zone (weeks start Monday). Use instead of start_date/end_date. | |
| end_date | No | Last day, YYYY-MM-DD, inclusive. Defaults to start_date. Max span 92 days. | |
| start_date | No | First day, YYYY-MM-DD, inclusive. Required unless period is given. |