Health Data Tools
Pull measured data from connected wearables.
Common parameters
All tools below take:
| Parameter | Required | Format |
|---|---|---|
from | yes | YYYY-MM-DD |
to | yes | YYYY-MM-DD |
zoneId | no, defaults to UTC | IANA timezone (e.g. America/New_York) |
Always pass zoneId — daily aggregations align with that timezone's day boundaries. UTC default rarely matches the user's day.
Use 7-30 day ranges. Very large ranges return a lot of data.
getActivityData
Daily activity and workouts from Apple Health, Strava, Garmin, Peloton, Wahoo. Includes steps, distance, active + basal calories, floors climbed, VO2 max, and workout sessions (running, cycling, yoga, weightlifting, swimming, hiking, etc.) with duration and details.
Extra parameter: activityTypes (optional) — comma-separated filter (e.g. "RUNNING,YOGA").
Returns: JSON with daily activity and workout sessions, attributed to the best available source.
getVitals
Vital sign measurements from Apple Health, Oura, Garmin, Withings. Includes heart rate, HRV, blood pressure (systolic/diastolic), SpO2, glucose, and respiratory rate per day.
Returns: JSON with daily vitals, attributed to source.
getSleepData
Nightly sleep summaries from Apple Health, Oura, Eight Sleep, Garmin. Includes time in bed, total time asleep, and breakdown by sleep stage (deep, light/core, REM, awake) per night.
Use this for sleep duration, sleep quality, or general sleep trends. For cycle-level detail, use getSleepStages.
getSleepStages
Minute-by-minute sleep stage transitions from Apple Health, Oura, Eight Sleep, Garmin. Each entry: stage name (Deep, Core, REM, Awake), start, end, duration. Grouped by night.
More granular than getSleepData. Use it when the user wants cycle-level analysis.
getBodyComposition
Body composition from Apple Health, Withings, Garmin. Includes weight, body fat %, body water %, muscle mass %, bone mass %, visceral fat index, BMI, lean body mass, waist circumference per day.
If a tool returns empty
- Verify with
listConnectedDevicesthat a relevant provider is connected - Some metrics need specific devices (HRV: Oura/Apple Watch; glucose: a CGM)
- Sync delays — most providers backfill within minutes, some up to a few hours