Sleep: the Google Health API sleep data type

Sleep at a glance

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

Display name

Sleep

dataType (in endpoint URLs)

sleep

filter parameter

sleepGoogle: “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

Session — Google: “Represents a continuous block of recording, such as a workout or an electrocardiogram (ECG) session.”

Storage resolution

not stated in Google’s table

Webhook support

Yes · automatic-subscription token WEBHOOK_DATA_TYPE_SLEEP

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

DataPoint.sleep → SleepIts description: “Optional. Data for points in the sleep session data type collection.”

Compatible devices

27 in Google’s table

Operations and request paths

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

Fields of Sleep

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

Fitbit Web API predecessor

Fitbit Web API scopes Google maps to sleep’s scopes: sleep.

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

Where Google’s guides name sleep

• “Variable page sizes: Capping limits depend on the endpoint and data type. For most data types, page sizes are capped at a maximum of 10,000. However, for certain data types like exercise and sleep, the default and maximum page size is capped at 25. For example, if a client requests all sleep data for the past 10 years, the API will still return only 25 sleep sessions on the first page.”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.

• Operation name differs

  The table lists "update" for sleep, but the discovery document has no method named update; Google's endpoint-mapping table points updates at patch.

  • Google's Fitbit migration API specifications: “CREATE & UPDATE Logs”
  • Google's Fitbit migration API specifications: “patch method”
  • the v4 discovery document: “Updates a single identifiable data point. If a data point with the specified name is not found, the request will fail.”

Compatible devices

The 27 devices Google’s table lists as able to record and sync sleep.

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