Google Health API reference

Weight: the Google Health API weight 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

Weight (weight) is a Sample data type in the Google Health API. Google's data-types table lists list, get, reconcile, rollup, dailyRollup, create, update and batchDelete for it under the .health_metrics_and_measurements.readonly and .health_metrics_and_measurements.writeonly scopes. The table marks it with webhook support. Google's Fitbit migration table maps the Fitbit Web API's Weight data to it.

Weight at a glance

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

Display name: Weight
dataType (in endpoint URLs): weight
filter parameter: weightGoogle: “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: Sample — Google: “Represents instantaneous measurements.”
Storage resolution: not stated in Google’s table
Webhook support: Yes · automatic-subscription token WEBHOOK_DATA_TYPE_WEIGHT
True zeros support: Not marked in Google’s table
Channel: v4
DataPoint field: DataPoint.weight → WeightIts description: “Optional. Data for points in the weight sample data type collection.”
Compatible devices: 3 in Google’s table

Operations and request paths

The operations Google’s table lists for weight, 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 weight. 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/weight/dataPoints`
`get`	`get`	`GET https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints/{dataPointsId}`
`reconcile`	`reconcile`	`GET https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:reconcile`
`rollup`	`rollUp`same name, different case	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:rollUp`
`dailyRollup`	`dailyRollUp`same name, different case	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:dailyRollUp`
`create`	`create`	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints`
`update`	`patch`via Google’s endpoint-mapping table (flagged below)	`PATCH https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints/{dataPointsId}`
`batchDelete`	`batchDelete`	`POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:batchDelete`

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

Scopes

The scopes Google’s table lists for weight, 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.health_metrics_and_measurements.readonly`	read	See your Google Health health metrics and measurement data.
`https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly`	write	Add health metric and measurements data to Google Health, and edit or delete the data it adds.

Fields of Weight

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

Weight — Google: “Body weight measurement.”

Field	Type	Google’s description
`sampleTime`Required	`ObservationSampleTime`	Required. The time at which the weight was measured
`weightGrams`Required	`number/double`	Required. Weight of a user in grams. Must be in the range `[0, 1000000]`.
`notes`Optional	`string`	Optional. Standard free-form notes captured at manual logging.

`ObservationSampleTime`

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

Field	Type	Google’s description
`physicalTime`Required	`string/google-datetime`	Required. The time of the observation.
`utcOffset`Required	`string/google-duration`	Required. The offset of the user's local time during the observation relative to the Coordinated Universal Time (UTC).
`civilTime`Output only	`CivilDateTime`	Output only. The civil time in the timezone the subject is in at the time of the observation.

Rollup fields

`rollUp` returns `RollupDataPoint.weight`

The discovery document: “Returned by default when rolling up data points from the weight data type, or when requested explicitly using the weight rollup type identifier.”

WeightRollupValue — Google: “Represents the result of the rollup of the weight data type.”

Field	Type	Google’s description
`weightGramsAvg`	`number/double`	Average weight in grams.

`dailyRollUp` returns `DailyRollupDataPoint.weight`

The discovery document: “Returned by default when rolling up data points from the weight data type, or when requested explicitly using the weight rollup type identifier.”

The same WeightRollupValue as the rollUp result above.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table maps Weight to weight.

Fitbit Web API scopes Google maps to weight’s scopes: blood_glucose, heartrate, oxygen_saturation, respiratory_rate, temperature, weight.

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 weight, 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 3 devices Google’s table lists as able to record and sync weight.

Fitbit Aria
Fitbit Aria 2
Fitbit Aria Air

Google’s documentation

Weight in the v4 REST reference

Related on this site

Body Composition API: Weight, Body Fat, and Lean Mass Data — 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 weight data type need?

Google's data-types table (read 2026-10-17) lists https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly and https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly for weight. The Scopes page's consent text: .health_metrics_and_measurements.readonly, "See your Google Health health metrics and measurement data."; .health_metrics_and_measurements.writeonly, "Add health metric and measurements data to Google Health, and edit or delete the data it adds."

Can apps write weight data to the Google Health API?

Yes. Google's data-types table lists create, update and batchDelete for weight. create is POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints. The table's "update" has no method of that name in the discovery document; Google's endpoint-mapping table points updates at patch, which is PATCH https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints/{dataPointsId}. batchDelete is POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:batchDelete. Writes need https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly.

How do you aggregate weight 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/weight/dataPoints:rollUp) returns RollupDataPoint.weight, a WeightRollupValue with weightGramsAvg; dailyRollUp (POST https://health.googleapis.com/v4/users/{usersId}/dataTypes/weight/dataPoints:dailyRollUp) returns DailyRollupDataPoint.weight, a WeightRollupValue with weightGramsAvg. Each field is described on this page as the discovery document describes it.

What did the Google Health API weight data type replace in the Fitbit Web API?

Google's Fitbit Web API migration table maps the Fitbit Web API's "Weight" to weight. The Fitbit Web API scopes Google maps to its scopes: blood_glucose, heartrate, oxygen_saturation, respiratory_rate, temperature and weight.

Other health metrics and measurements data types

All health metrics and measurements 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
API specifications — last updated 2026-09-22 · 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