2026-04-02
▼ ▲ health.users.updateSettings
Flat Path : v4/users/{usersId}/settings
HTTP Method : PATCH
Parameter Order : name
Description : Updates the user's settings details.
Path : v4/{+name}
Parameters :
updateMask
Description : Optional. The list of fields to be updated.
Location : query
Type : string
Format : google-fieldmask
name
Description : Identifier. The resource name of this Settings resource. Format: `users/{user}/settings` Example: `users/1234567890/settings` or `users/me/settings` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
Location : path
Pattern : ^users/[^/]+/settings$
Required : Yes
Type : string
▼ ▲ health.users.getSettings
Flat Path : v4/users/{usersId}/settings
HTTP Method : GET
Parameters :
name
Pattern : ^users/[^/]+/settings$
Required : Yes
Type : string
Description : Required. The name of the Settings. Format: `users/me/settings`.
Location : path
Path : v4/{+name}
Description : Returns user settings details.
Parameter Order : name
▼ ▲ health.users.getIdentity
Parameter Order : name
Description : Gets the user's identity. It includes the legacy Fitbit user ID and the Google user ID and it can be used by migrating clients to map identifiers between the two systems.
Path : v4/{+name}
Parameters :
name
Description : Required. The resource name of the Identity. Format: `users/me/identity`
Location : path
Pattern : ^users/[^/]+/identity$
Required : Yes
Type : string
Flat Path : v4/users/{usersId}/identity
HTTP Method : GET
▼ ▲ health.users.updateProfile
Parameters :
updateMask
Format : google-fieldmask
Description : Optional. The list of fields to be updated.
Location : query
Type : string
name
Description : Identifier. The resource name of this Profile resource. Format: `users/{user}/profile` Example: `users/1234567890/profile` or `users/me/profile` The {user} ID is a system-generated Google Health API user ID, a string of 1-63 characters consisting of lowercase and uppercase letters, numbers, and hyphens. The literal `me` can also be used to refer to the authenticated user.
Location : path
Pattern : ^users/[^/]+/profile$
Required : Yes
Type : string
Path : v4/{+name}
Description : Updates the user's profile details.
Flat Path : v4/users/{usersId}/profile
HTTP Method : PATCH
Parameter Order : name
▼ ▲ health.users.getProfile
Parameter Order : name
Parameters :
name
Pattern : ^users/[^/]+/profile$
Required : Yes
Type : string
Description : Required. The name of the Profile. Format: `users/me/profile`.
Location : path
Flat Path : v4/users/{usersId}/profile
HTTP Method : GET
Description : Returns user Profile details.
Path : v4/{+name}
▼ ▲ health.users.dataTypes.dataPoints.batchDelete
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:batchDelete
HTTP Method : POST
Parameter Order : parent
Description : Delete a batch of identifyable data points.
Path : v4/{+parent}/dataPoints:batchDelete
Parameters :
parent
Description : Optional. Parent (data type) for the Data Point collection Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/-` For a list of the supported data types see the DataPoint data union field. Deleting data points across multiple data type collections is supported following https://aip.dev/159. If this is set, the parent of all of the data points specified in `names` must match this field.
Location : path
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
▼ ▲ health.users.dataTypes.dataPoints.create
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints
HTTP Method : POST
Parameter Order : parent
Parameters :
parent
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
Description : Required. The parent resource name where the data point will be created. Format: `users/{user}/dataTypes/{data_type}`
Location : path
Path : v4/{+parent}/dataPoints
Description : Creates a single identifiable data point.
▼ ▲ health.users.dataTypes.dataPoints.patch
Path : v4/{+name}
Description : Updates a single identifiable data point. If a data point with the specified `name` is not found, the request will fail.
Parameters :
name
Description : Identifier. Data point name, only supported for the subset of identifiable data types. For the majority of the data types, individual data points do not need to be identified and this field would be empty. Format: `users/{user}/dataTypes/{data_type}/dataPoints/{data_point}` Example: `users/abcd1234/dataTypes/sleep/dataPoints/a1b2c3d4-e5f6-7890-1234-567890abcdef` The `{user}` ID is a system-generated identifier, as described in Profile.encoded_id. The `{data_type}` ID corresponds to the kebab-case version of the field names in the DataPoint data union field, e.g. `total-calories` for the `total_calories` field. The `{data_point}` ID can be client-provided or system-generated. If client-provided, it must be a string of 4-63 characters, containing only lowercase letters, numbers, and hyphens.
Location : path
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Required : Yes
Type : string
updateMask
Format : google-fieldmask
Description : Optional. The list of fields to update.
Location : query
Type : string
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}
HTTP Method : PATCH
Parameter Order : name
▼ ▲ health.users.dataTypes.dataPoints.dailyRollUp
Parameters :
parent
Description : Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the DailyRollupDataPoint value union field.
Location : path
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
Path : v4/{+parent}/dataPoints:dailyRollUp
Description : Roll up data points over civil time intervals for supported data types.
Parameter Order : parent
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:dailyRollUp
HTTP Method : POST
▼ ▲ health.users.dataTypes.dataPoints.rollUp
Parameter Order : parent
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:rollUp
HTTP Method : POST
Parameters :
parent
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
Description : Required. Parent data type of the Data Point collection. Format: `users/{user}/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/distance` For a list of the supported data types see the RollupDataPoint value union field.
Location : path
Description : Roll up data points over physical time intervals for supported data types.
Path : v4/{+parent}/dataPoints:rollUp
▼ ▲ health.users.dataTypes.dataPoints.list
Parameter Order : parent
Path : v4/{+parent}/dataPoints
Description : Query user health and fitness data points.
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints
HTTP Method : GET
Parameters :
parent
Description : Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field.
Location : path
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The `next_page_token` from a previous request, if any.
Location : query
Type : string
filter
Description : Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_resting_heart_rate.date >= "2024-08-14"` - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
Location : query
Type : string
▼ ▲ health.users.dataTypes.dataPoints.exportExerciseTcx
Parameters :
name
Pattern : ^users/[^/]+/dataTypes/[^/]+/dataPoints/[^/]+$
Required : Yes
Type : string
Description : Required. The resource name of the exercise data point to export. Format: `users/{user}/dataTypes/exercise/dataPoints/{data_point}` Example: `users/me/dataTypes/exercise/dataPoints/2026443605080188808` The `{user}` is the alias `"me"` currently. Future versions may support user IDs. The `{data_point}` ID maps to the exercise ID, which is a long integer.
Location : path
partialData
Description : Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to `false` and partial data will not be included.
Location : query
Type : boolean
Usemediadownloadservice : Yes
Description : Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
Path : v4/{+name}:exportExerciseTcx
Parameter Order : name
Supportsmediadownload : Yes
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints/{dataPointsId}:exportExerciseTcx
HTTP Method : GET
▼ ▲ health.users.dataTypes.dataPoints.reconcile
Parameter Order : parent
Path : v4/{+parent}/dataPoints:reconcile
Description : Reconcile data points from multiple data sources into a single data stream.
Flat Path : v4/users/{usersId}/dataTypes/{dataTypesId}/dataPoints:reconcile
HTTP Method : GET
Parameters :
pageToken
Description : Optional. The `next_page_token` from a previous request, if any.
Location : query
Type : string
filter
Description : Optional. Filter expression based on https://aip.dev/160. A time range, either physical or civil, can be specified. See the ListDataPointsRequest.filter for the supported fields and syntax.
Location : query
Type : string
parent
Description : Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/heart-rate` For a list of the supported data types see the DataPoint data union field.
Location : path
Pattern : ^users/[^/]+/dataTypes/[^/]+$
Required : Yes
Type : string
pageSize
Description : Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
Location : query
Type : integer
Format : int32
dataSourceFamily
Description : Optional. The data source family name to reconcile. If empty, data points from all data sources will be reconciled. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - default value - `users/me/dataSourceFamilies/google-wearables` - tracker devices - `users/me/dataSourceFamilies/google-sources` - Google first party sources
Location : query
Type : string