Distance: the Google Health API distance data type

Distance at a glance

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

Display name

Distance

dataType (in endpoint URLs)

distance

filter parameter

distanceGoogle: “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_DISTANCE

True zeros support

Yes

Channel

v4

DataPoint field

DataPoint.distance → DistanceIts description: “Optional. Data for points in the distance interval data type collection.”

Compatible devices

28 in Google’s table

Operations and request paths

The operations Google’s table lists for distance, 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 distance. 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 distance, as full URLs, with the consent text Google’s Scopes page gives each. Every Google Health API scope.

Fields of Distance

The schema the discovery document gives DataPoint.distance, 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 distance’s scopes: activity, cardio_fitness.

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

Where Google’s guides name distance

• “Rollup window size: When calling the rollUp endpoint, the windowSize duration must be at least 1 second ("1s"). Sub-second durations are rejected with INVALID_ARGUMENT. In addition, choose a windowSize equal to or larger than the data type's underlying storage resolution (such as "60s" for 1-minute interval data types like steps and distance) to avoid uneven distribution across sub-intervals. For details, see Rollup window and storage resolution.”Google's data-types page, “Query constraints”

Compatible devices

The 28 devices Google’s table lists as able to record and sync distance.

• Fitbit Air
• Fitbit Alta
• Fitbit Alta HR
• Fitbit Blaze
• Fitbit Charge 2
• Fitbit Charge 3
• Fitbit Charge 4
• Fitbit Charge 5
• Fitbit Charge 6
• Fitbit Flex 2
• Fitbit Inspire
• Fitbit Inspire 2
• Fitbit Inspire 3
• Fitbit Inspire HR
• Fitbit Ionic
• Fitbit Luxe
• Fitbit MobileTrack
• 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