Health

Get heart rate timeline for the day

Returns heart rate data points throughout the day with hourly granularity

get/api/health/heart-rate-timeline

Request

  • Base URL
    https://api.hiyd.ai
  • Auth
    HTTP bearer

Query parameters

datestring date
Example:2026-01-24

Date for the timeline (defaults to today)

granularity'hourly' | 'week' | 'month' | 'year'
  • hourly: Hourly data for specified date
  • week: Daily data for last 7 days
  • month: Daily data for last 30 days
  • year: Monthly data for last 12 months
time_zonestring
Example:America/Los_Angeles

IANA zone the day boundary and the hourly buckets (hour_24) are resolved in. Omitted or unrecognised values mean UTC. For many days of the hourly view's daytime low and stats.current at once, see /api/health/heart-rate-days.

Response

Heart rate timeline data. Hourly stats carry current, the day's latest heart-rate reading, and current_at, the ISO-8601 UTC time of that reading (the phone row's time, or for a tracker reading its window's midpoint), both null when the day has none. Week, month and year stats have neither.

Changes

No recorded changes to this operation across all 1 revision of this API.