The Google Fit APIs, including the Google Fit REST API, will no longer be available after June 30, 2025. As of May 1, 2024, developers cannot sign up to use these APIs.

For instructions on which API or platform to migrate to, visit the Health Connect migration guide. For a comparison of Health Connect with the Google Fit APIs and the Fitbit Web APIs, visit the Health Connect comparison guide.

Learn more about Health Connect and how to integrate with the API.

Users.dataSources

Definition of a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point inserted into or read from this service has an associated data source.

The data source contains enough information to uniquely identify its data, including the hardware device and the application that collected and/or transformed the data. It also holds useful metadata, such as the hardware and application versions, and the device type.

Each data source produces a unique stream of data, with a unique identifier. Not all changes to data source affect the stream identifier, so that data collected by updated versions of the same application/device can still be considered to belong to the same data stream.

For a list of methods for this resource, see the end of this page.

Resource representations

{
  "dataStreamId": string,
  "name": string,
  "dataStreamName": string,
  "type": string,
  "dataType": {
    "name": string,
    "field": [
      {
        "name": string,
        "format": string,
        "optional": boolean
      }
    ]
  },
  "device": {
    "uid": string,
    "type": string,
    "version": string,
    "model": string,
    "manufacturer": string
  },
  "application": {
    "packageName": string,
    "version": string,
    "detailsUrl": string,
    "name": string
  },
  "dataQualityStandard": [
    string
  ]
}

Property name	Value	Description
`application`	`nested object`	Information about an application which feeds sensor data into the platform.
`application.detailsUrl`	`string`	An optional URI that can be used to link back to the application.
`application.name`	`string`	The name of this application. This is required for REST clients, but we do not enforce uniqueness of this name. It is provided as a matter of convenience for other developers who would like to identify which REST created an Application or Data Source.
`application.packageName`	`string`	Package name for this application. This is used as a unique identifier when created by Android applications, but cannot be specified by REST clients. REST clients will have their developer project number reflected into the Data Source data stream IDs, instead of the packageName.
`application.version`	`string`	Version of the application. You should update this field whenever the application changes in a way that affects the computation of the data.
`dataQualityStandard[]`	`list`	DO NOT POPULATE THIS FIELD. It is never populated in responses from the platform, and is ignored in queries. It will be removed in a future version entirely.
`dataStreamId`	`string`	A unique identifier for the data stream produced by this data source. The identifier includes: The physical device's manufacturer, model, and serial number (UID). The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. The data source's type. The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: `type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName` The exact format of the data stream ID created by a REST client is: `type:dataType.name:developer project number:device.manufacturer:device.model:device.uid:dataStreamName` When any of the optional fields that make up the data stream ID are absent, they will be omitted from the data stream ID. The minimum viable data stream ID would be: type:dataType.name:developer project number Finally, the developer project number and device UID are obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. This means a client will see a different set of data_stream_ids than another client with different credentials.
`dataStreamName`	`string`	The stream name uniquely identifies this particular data source among other data sources of the same type from the same underlying producer. Setting the stream name is optional, but should be done whenever an application exposes two streams for the same data type, or when a device has two equivalent sensors.
`dataType`	`nested object`	The data type defines the schema for a stream of data being collected by, inserted into, or queried from the Fitness API.
`dataType.field[]`	`list`	A field represents one dimension of a data type.
`dataType.field[].format`	`string`	The different supported formats for each field in a data type. Acceptable values are: "`blob`" "`floatList`" "`floatPoint`" "`integer`" "`integerList`" "`map`" "`string`"
`dataType.field[].name`	`string`	Defines the name and format of data. Unlike data type names, field names are not namespaced, and only need to be unique within the data type.
`dataType.field[].optional`	`boolean`
`dataType.name`	`string`	Each data type has a unique, namespaced, name. All data types in the com.google namespace are shared as part of the platform.
`device`	`nested object`	Representation of an integrated device (such as a phone or a wearable) that can hold sensors.
`device.manufacturer`	`string`	Manufacturer of the product/hardware.
`device.model`	`string`	End-user visible model name for the device.
`device.type`	`string`	A constant representing the type of the device. Acceptable values are: "`chestStrap`" "`headMounted`" "`phone`" "`scale`" "`smartDisplay`" "`tablet`" "`unknown`" "`watch`"
`device.uid`	`string`	The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. The obfuscation preserves equality; that is, given two IDs, if id1 == id2, obfuscated(id1) == obfuscated(id2).
`device.version`	`string`	Version string for the device hardware/software.
`name`	`string`	An end-user visible name for this data source.
`type`	`string`	A constant describing the type of this data source. Indicates whether this data source produces raw or derived data. Acceptable values are: "`derived`" "`raw`"

Methods

create: Creates a new data source that is unique across all data sources belonging to this user.

A data source is a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point in every dataset inserted into or read from the Fitness API has an associated data source.

Each data source produces a unique stream of dataset updates, with a unique data source identifier. Not all changes to data source affect the data stream ID, so that data collected by updated versions of the same application/device can still be considered to belong to the same data source.

Data sources are identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, it must match the format that the server would generate. This format is a combination of some fields from the data source, and has a specific order. If it doesn't match, the request will fail with an error.

Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a custom data type. Custom data types are only readable by the application that created them. Custom data types are deprecated; use standard data types instead.

In addition to the data source fields included in the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types.
delete: Deletes the specified data source. The request will fail if the data source contains any data points.
get: Returns the specified data source.
list: Lists all data sources that are visible to the developer, using the OAuth scopes provided. The list is not exhaustive; the user may have private data sources that are only visible to other developers, or calls using other scopes.
update: Updates the specified data source. The dataStreamId, dataType, type, dataStreamName, and device properties with the exception of version, cannot be modified.

Data sources are identified by their dataStreamId.