Calories In Heart Rate Zone: the Google Health API calories-in-heart-rate-zone data type

Calories In Heart Rate Zone at a glance

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

Display name

Calories In Heart Rate Zone

dataType (in endpoint URLs)

calories-in-heart-rate-zone

filter parameter

calories_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_CALORIES_IN_HEART_RATE_ZONE

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

none in the discovery documents — see the flags below

Compatible devices

0 in Google’s table

Operations and request paths

The operations Google’s table lists for calories-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 calories-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).”

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

Scopes

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

Rollup fields

Fitbit Web API predecessor

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

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

Where Google’s guides name calories-in-heart-rate-zone

• “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”

Where Google’s pages disagree

Published as found, with the texts that disagree; nothing here is corrected by us.

• No v4 DataPoint field

  Neither discovery document has a DataPoint property for calories-in-heart-rate-zone; it exists only as a rollup (caloriesInHeartRateZone), matching the table's operations (rollup, dailyRollup).

  • Google's data-types page: “Calories In Heart Rate Zone”
  • Google's data-types page: “rollup, dailyRollup”
  • the v4 discovery document: “Returned by default when rolling up data points from the calories-in-heart-rate-zone data type, or when requested explicitly using the calories-in-heart-rate-zone rollup type identifier.”