Get Sleep Data
get_sleep_dataRetrieve sleep metrics for a date: duration, stages, quality score, and nightly summary. Optionally include per-minute time series for deeper analysis.
Instructions
Get a night of sleep: duration, sleep stages, quality score and the nightly summary. The per-minute series behind it (movement, heart rate, stress, body battery, HRV, respiration) are reported as counts only; set includeTimeSeries to inline them, or use the dedicated tool for the one series you need.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_sleep_data"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date | No | Date in YYYY-MM-DD format. Defaults to today if not specified. | |
| includeTimeSeries | No | Inline every per-minute series for the night (default false). This is a very large response; prefer get_sleep_movement, get_hrv_data or get_respiration_data for a single series. |