get_heart_rate
Retrieve heart rate samples (bpm) recorded every 5 minutes, tagged by source (awake, rest, sleep, workout, session, live). Defaults to last 24 hours; supports aggregation and latest-sample options.
Instructions
Get heart rate samples (bpm) at roughly 5 minute intervals, each tagged with its source: awake, rest, sleep, workout, session or live. Defaults to the last 24 hours.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| latest | No | Return only the most recent sample. | |
| aggregate | No | Summarize samples into hourly or daily min/avg/max buckets (UTC). Recommended for windows longer than a day; raw data is 288 samples a day. | |
| next_token | No | Continue a truncated result: pass the next_token from the previous response along with the same dates. | |
| end_datetime | No | End of the window, ISO 8601 datetime. Defaults to now. | |
| start_datetime | No | Start of the window, ISO 8601 datetime such as '2026-01-15T00:00:00-08:00'. Defaults to 24 hours before end_datetime. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |