Sign in
latestSwagger 2.0BSD License2026-08-107753105.4 KB

52b0eb5e8b96

profile

Heart Rate Sample

Heart Rate measured at a single point in time.

get/profile/{profile_public_id}/heartrate_sample/

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page.

date_startstring date-time

Lower bound of date or timestamp.

date_endstring date-time

Upper bound of date or timestamp.

heart_rate_detailboolean

If set to true it will add heart_rate_samples field

Response

OK

timestampstring date-time required

Starting UTC time of the measurement.

durationstring nullable

Duration of the measurement.

source'AGGREGATED' | 'ANDROID' | 'APPLE' | 'FITBIT' | 'GARMIN' | 'GOOGLE_HEALTH' | 'GOOGLEFIT' | 'HEALTHCONNECT' | 'HUAWEI' | 'MYZONE' | 'OMH' | 'OMRON' | 'OURA' | 'POLAR' | 'SAMSUNG' | 'STRAVA' | 'SUUNTO' | 'WF' | 'WHOOP' | 'WITHINGS' required

Origin of the data.

is_manualboolean nullable

Whether the data was entered manually.

valueinteger nullable

Measured heart rate in beats/min.

mininteger nullable

Minimum value measured in the time window.

maxinteger nullable

Maximum value measured in the time window.