get_rest_mode_periods
Retrieve rest mode periods with start and end times and logged episodes by date range. Useful for tracking illness or recovery periods from Oura data.
Instructions
Get rest mode periods (when the user turned on rest mode, typically for illness or recovery), with start and end times and logged episodes.
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. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |