Google Health API reference

Time in Heart Rate Zone: the Google Health API time-in-heart-rate-zone data type

Read from Google’s documentation on 2026-10-17 · discovery document revision 20261014 · Google’s data-types page last updated 2026-10-06

Time in Heart Rate Zone (time-in-heart-rate-zone) is an Interval data type in the Google Health API. Google's data-types table lists list, reconcile, rollup and dailyRollup for it under the .activity_and_fitness.readonly and .activity_and_fitness.writeonly scopes, with a storage resolution of 1 minute. The table marks it with webhook support. Google's Fitbit migration table names no Fitbit Web API predecessor for it.

Time in Heart Rate Zone at a glance

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

Display name: Time in Heart Rate Zone
dataType (in endpoint URLs): time-in-heart-rate-zone
filter parameter: time_in_heart_rate_zoneGoogle: “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: Interval — Google: “Represents measurements recorded over a duration.”
Storage resolution: 1 minute
Webhook support: Yes · automatic-subscription token WEBHOOK_DATA_TYPE_TIME_IN_HEART_RATE_ZONE
True zeros support: Not marked in Google’s table
Channel: v4
DataPoint field: DataPoint.timeInHeartRateZone → TimeInHeartRateZoneIts description: “Optional. Data for points in the time-in-heart-rate-zone interval data type collection.”
Compatible devices: 0 in Google’s table

Operations and request paths

The operations Google’s table lists for time-in-heart-rate-zone, 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 time-in-heart-rate-zone. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Table lists	Method	Documented path template
`list`	`list`	`GET https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints`
`reconcile`	`reconcile`	`GET https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints:reconcile`
`rollup`	`rollUp`same name, different case	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints:rollUp`
`dailyRollup`	`dailyRollUp`same name, different case	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints:dailyRollUp`

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

Scopes

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

Scope	Access	Google’s permission text
`https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly`	read	See your Google Health activity and fitness data.
`https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly`	write	Add activity and fitness data to Google Health, and edit or delete the data it adds.

Fields of Time in Heart Rate Zone

The schema the discovery document gives DataPoint.timeInHeartRateZone, 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.

TimeInHeartRateZone — Google: “Time in heart rate zone record. It's an interval spent in specific heart rate zone.”

Field	Type	Google’s description
`heartRateZoneType`Required	`string`	Required. Heart rate zone type. `HEART_RATE_ZONE_TYPE_UNSPECIFIED` — Unspecified heart rate zone. `LIGHT` — The light heart rate zone. `MODERATE` — The moderate heart rate zone. `VIGOROUS` — The vigorous heart rate zone. `PEAK` — The peak heart rate zone.
`interval`Required	`ObservationTimeInterval`	Required. Observed interval.

`ObservationTimeInterval`

Google: “Represents a time interval of an observed data point.”

Field	Type	Google’s description
`endTime`Required	`string/google-datetime`	Required. Observed interval end time.
`endUtcOffset`Required	`string/google-duration`	Required. The offset of the user's local time at the end of the observation relative to the Coordinated Universal Time (UTC).
`startTime`Required	`string/google-datetime`	Required. Observed interval start time.
`startUtcOffset`Required	`string/google-duration`	Required. The offset of the user's local time at the start of the observation relative to the Coordinated Universal Time (UTC).
`civilEndTime`Output only	`CivilDateTime`	Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
`civilStartTime`Output only	`CivilDateTime`	Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval

Rollup fields

`rollUp` returns `RollupDataPoint.timeInHeartRateZone`

The discovery document: “Returned by default when rolling up data points from the time-in-heart-rate-zone data type, or when requested explicitly using the time-in-heart-rate-zone rollup type identifier.”

TimeInHeartRateZoneRollupValue — Google: “Represents the result of the rollup of the time in heart rate zone data type.”

Field	Type	Google’s description
`timeInHeartRateZones`	`array<TimeInHeartRateZoneValue>`	List of time spent in each heart rate zone.

`TimeInHeartRateZoneValue`

Google: “Represents the total time spent in a specific heart rate zone.”

Field	Type	Google’s description
`duration`	`string/google-duration`	The total time spent in the specified heart rate zone.
`heartRateZone`	`string`	The heart rate zone. `HEART_RATE_ZONE_TYPE_UNSPECIFIED` — Unspecified heart rate zone. `LIGHT` — The light heart rate zone. `MODERATE` — The moderate heart rate zone. `VIGOROUS` — The vigorous heart rate zone. `PEAK` — The peak heart rate zone.

`dailyRollUp` returns `DailyRollupDataPoint.timeInHeartRateZone`

The same TimeInHeartRateZoneRollupValue as the rollUp result above.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table has no row for time-in-heart-rate-zone, so it names no Fitbit Web API predecessor.

Fitbit Web API scopes Google maps to time-in-heart-rate-zone’s scopes: activity, cardio_fitness.

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

Google’s documentation

Time in Heart Rate Zone in the v4 REST reference

Related on this site

Heart Rate Zones API: Zone Thresholds and Time in Zone — the metric on every platform this site covers, each type quoted in its platform's own words
Google Health API webhooks
Verification and rate limits
The Fitbit Web API turn-off

Questions

Which OAuth scopes does the Google Health API time-in-heart-rate-zone data type need?

Google's data-types table (read 2026-10-17) lists https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly and https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly for time-in-heart-rate-zone. The Scopes page's consent text: .activity_and_fitness.readonly, "See your Google Health activity and fitness data."; .activity_and_fitness.writeonly, "Add activity and fitness data to Google Health, and edit or delete the data it adds."

Can apps write time in heart rate zone data to the Google Health API?

Not according to Google's data-types table, read 2026-10-17: it lists only list, reconcile, rollup and dailyRollup for time-in-heart-rate-zone, and no create, update or batchDelete operation.

How do you aggregate time-in-heart-rate-zone data with the Google Health API?

With the rollup methods Google's table lists for it. rollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints:rollUp) returns RollupDataPoint.timeInHeartRateZone, a TimeInHeartRateZoneRollupValue with timeInHeartRateZones; dailyRollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/time-in-heart-rate-zone/dataPoints:dailyRollUp) returns DailyRollupDataPoint.timeInHeartRateZone, a TimeInHeartRateZoneRollupValue with timeInHeartRateZones. Each field is described on this page as the discovery document describes it.

Does the Google Health API send webhooks for time-in-heart-rate-zone?

Yes. Google's data-types table marks time-in-heart-rate-zone with webhook support, the webhooks guide lists it, and automatic subscriptions name it with the token WEBHOOK_DATA_TYPE_TIME_IN_HEART_RATE_ZONE.

Other activity and fitness data types

All activity and fitness data types →

Sources checked

Google Health API data types — last updated 2026-10-06 · read 2026-10-17
Google Health API discovery document (v4) — revision 20261014 · read 2026-10-17
Scopes — last updated 2026-10-09 · read 2026-10-17

Google’s text is quoted for identification; each guide page’s footer reads: “Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.”. Generated from Google’s pages by scripts/fetch-google-health-api.mjs, not typed by hand; Google’s documentation remains the authority.

← All Google Health API data types