Hydration Log: the Google Health API hydration-log data type

Hydration Log at a glance

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

Display name

Hydration Log

dataType (in endpoint URLs)

hydration-log

filter parameter

hydration_logGoogle: “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_HYDRATION_LOG

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

DataPoint.hydrationLog → HydrationLogIts description: “Optional. Data for points in the hydration-log session data type collection.”

Compatible devices

0 in Google’s table

Operations and request paths

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

Fields of Hydration Log

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

Google’s Fitbit Web API → Google Health API data-type table has no row for hydration-log, so it names no Fitbit Web API predecessor.

Fitbit Web API scopes Google maps to hydration-log’s scopes: nutrition.

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

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 hydration-log, 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.”

• Scope missing from the discovery document

  The table lists .nutrition.readonly for hydration-log, but the v4 discovery document defines no https://www.googleapis.com/auth/googlehealth.nutrition.readonly scope, and none of its methods accepts it.

  • Google's data-types page: “.nutrition.readonly”
  • Google's Scopes page: “See your Google Health nutrition data.”