Get heart rate
get_heart_rateRetrieve heart-rate time series between two times, aggregated into 5-minute, hourly, or daily buckets with average, minimum, and maximum BPM and source stats. Defaults to last 24 hours.
Instructions
Get the heart-rate time series between two times, aggregated into buckets aligned to local time (5min, 15min, hour or day) with avg/min/max bpm and the dominant source, plus overall and per-source stats (awake, rest, sleep, workout, session, live). Use it for heart rate at particular times, during a workout or across a day; for overnight averages, lowest heart rate and HRV prefer list_sleep_periods. Defaults to the last 24 hours at hourly resolution; ranges are limited to 30 days per call. resolution 'raw' returns individual samples (the first 2000); latest: true returns only the most recent sample and ignores the other arguments. truncated: true means the range held more samples than one call fetches, so narrow it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end | No | End: a date (includes that whole day) or ISO 8601 date-time. Defaults to now. | |
| start | No | Start: a date (YYYY-MM-DD, local midnight) or ISO 8601 date-time. Defaults to 24 hours ago. | |
| latest | No | Return only the most recent sample; other arguments are ignored. | |
| source | No | Only include samples recorded in this context. | |
| resolution | No | Bucket size. "raw" returns individual samples (truncated after 2000). | hour |