Heart Rate: the Google Health API heart-rate data type

Heart Rate at a glance

From the Heart Rate row of Google’s data-types table, joined to the discovery document’s DataPoint schema.

Display name

Heart Rate

dataType (in endpoint URLs)

heart-rate

filter parameter

heart_rateGoogle: “The identifier separated by underscores (for example, active_minutes) used as the value for the dataType filter parameter in daily rollup and rollup requests.”

Record type

Sample — Google: “Represents instantaneous measurements.”

Storage resolution

1 second

Webhook support

Yes · automatic-subscription token WEBHOOK_DATA_TYPE_HEART_RATE

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

DataPoint.heartRate → HeartRateIts description: “Optional. Data for points in the heart-rate sample data type collection.”

Compatible devices

24 in Google’s table

Operations and request paths

The operations Google’s table lists for heart-rate, each matched to its users.dataTypes.dataPoints method in the discovery document. The path is the documented path template (the method’s flatPath on https://health.googleapis.com/) with {dataTypesId} filled in as heart-rate. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Every method, and how many of the data types list it: the methods overview.

Scopes

The scopes Google’s table lists for heart-rate, as full URLs, with the consent text Google’s Scopes page gives each. Every Google Health API scope.

Fields of Heart Rate

The schema the discovery document gives DataPoint.heartRate, required fields first. Types are as the discovery document states them; the label is the word Google’s description opens with. The schemas its fields refer to follow, one level deep.

Rollup fields

Fitbit Web API predecessor

Fitbit Web API scopes Google maps to heart-rate’s scopes: blood_glucose, heartrate, oxygen_saturation, respiratory_rate, temperature, weight.

Google’s full Fitbit Web API mapping tables · the migration playbook

Where Google’s guides name heart-rate

• “A maximum query range of 14 days for calories-in-heart-rate-zone, heart-rate, active-minutes, and total-calories.”Google's data-types page, “Query constraints”
• “A maximum range of 14 days for calories-in-heart-rate-zone, heart-rate, active-minutes, and total-calories.”Google's endpoints guide, “Query historical data”

Compatible devices

The 24 devices Google’s table lists as able to record and sync heart-rate.

• Fitbit Air
• Fitbit Alta HR
• Fitbit Blaze
• Fitbit Charge 2
• Fitbit Charge 3
• Fitbit Charge 4
• Fitbit Charge 5
• Fitbit Charge 6
• Fitbit Inspire 2
• Fitbit Inspire 3
• Fitbit Inspire HR
• Fitbit Ionic
• Fitbit Luxe
• Pixel Watch
• Pixel Watch 2
• Pixel Watch 3
• Pixel Watch 4
• Fitbit Sense
• Fitbit Sense 2
• Fitbit Versa
• Fitbit Versa 2
• Fitbit Versa 3
• Fitbit Versa 4
• Fitbit Versa Lite