Users.dataSources.datasets: get
Stay organized with collections
Save and categorize content based on your preferences.
Returns a dataset containing all data points whose start and end times
overlap with the specified range of the dataset minimum start time and
maximum end time. Specifically, any data point whose start time is less
than or equal to the dataset end time and whose end time is greater than or
equal to the dataset start time.
Try it now.
Request
HTTP request
GET https://www.googleapis.com/fitness/v1/users/userId/dataSources/dataSourceId/datasets/datasetId
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
dataSourceId |
string |
The data stream ID of the data source that created the dataset.
|
datasetId |
string |
Dataset identifier that is a composite of the minimum data point start time
and maximum data point end time represented as nanoseconds from the epoch.
The ID is formatted like: "startTime-endTime"
where startTime and endTime are 64 bit integers.
|
userId |
string |
Retrieve a dataset for the person identified. Use me to
indicate the authenticated user. Only me is supported at this
time.
|
| Optional query parameters |
limit |
integer |
If specified, no more than this many data points will be included in the
dataset. If there are more data points in the dataset, nextPageToken
will be set in the dataset response.
The limit is applied from the end of the time range. That is, if
pageToken is absent, the limit most recent data
points will be returned.
|
pageToken |
string |
The continuation token, which is used to page through large datasets.
To get the next page of a dataset, set this parameter to the value of
nextPageToken from the previous response. Each subsequent
call will yield a partial dataset with data point end timestamps that are
strictly smaller than those in the previous partial response.
|
Authorization
This request requires authorization with at least one of the following scopes:
| Scope |
|---|
https://www.googleapis.com/auth/fitness.activity.read |
https://www.googleapis.com/auth/fitness.activity.write |
https://www.googleapis.com/auth/fitness.location.read |
https://www.googleapis.com/auth/fitness.location.write |
https://www.googleapis.com/auth/fitness.body.read |
https://www.googleapis.com/auth/fitness.body.write |
https://www.googleapis.com/auth/fitness.nutrition.read |
https://www.googleapis.com/auth/fitness.nutrition.write |
https://www.googleapis.com/auth/fitness.blood_pressure.read |
https://www.googleapis.com/auth/fitness.blood_pressure.write |
https://www.googleapis.com/auth/fitness.blood_glucose.read |
https://www.googleapis.com/auth/fitness.blood_glucose.write |
https://www.googleapis.com/auth/fitness.oxygen_saturation.read |
https://www.googleapis.com/auth/fitness.oxygen_saturation.write |
https://www.googleapis.com/auth/fitness.body_temperature.read |
https://www.googleapis.com/auth/fitness.body_temperature.write |
https://www.googleapis.com/auth/fitness.reproductive_health.read |
https://www.googleapis.com/auth/fitness.reproductive_health.write |
For more information, see the authentication and authorization page.
Request body
Do not supply a request body with this method.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
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. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-11-20 UTC.
[null,null,["Last updated 2023-11-20 UTC."],[[["\u003cp\u003eRetrieves a dataset containing all data points within a specified time range, overlapping with the dataset's minimum start and maximum end times.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with specific scopes related to fitness data access (e.g., \u003ccode\u003ehttps://www.googleapis.com/auth/fitness.activity.read\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to the endpoint \u003ccode\u003ehttps://www.googleapis.com/fitness/v1/users/userId/dataSources/dataSourceId/datasets/datasetId\u003c/code\u003e with parameters for user, data source, and dataset identification.\u003c/p\u003e\n"],["\u003cp\u003eAllows optional parameters like \u003ccode\u003elimit\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e to control the size and pagination of the returned dataset.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eUsers.dataSources.datasets\u003c/code\u003e resource upon successful execution, containing the requested fitness data.\u003c/p\u003e\n"]]],[],null,["# Users.dataSources.datasets: get\n\n| **Note:** Requires [authorization](#auth).\n\nReturns a dataset containing all data points whose start and end times\noverlap with the specified range of the dataset minimum start time and\nmaximum end time. Specifically, any data point whose start time is less\nthan or equal to the dataset end time and whose end time is greater than or\nequal to the dataset start time.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/fitness/v1/users/userId/dataSources/dataSourceId/datasets/datasetId\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `dataSourceId` | `string` | The data stream ID of the data source that created the dataset. |\n| `datasetId` | `string` | Dataset identifier that is a composite of the minimum data point start time and maximum data point end time represented as nanoseconds from the epoch. The ID is formatted like: \"\u003cvar translate=\"no\"\u003estartTime\u003c/var\u003e-\u003cvar translate=\"no\"\u003eendTime\u003c/var\u003e\" where \u003cvar translate=\"no\"\u003estartTime\u003c/var\u003e and \u003cvar translate=\"no\"\u003eendTime\u003c/var\u003e are 64 bit integers. |\n| `userId` | `string` | Retrieve a dataset for the person identified. Use `me` to indicate the authenticated user. Only `me` is supported at this time. |\n| **Optional query parameters** |||\n| `limit` | `integer` | If specified, no more than this many data points will be included in the dataset. If there are more data points in the dataset, nextPageToken will be set in the dataset response. The limit is applied from the end of the time range. That is, if \u003cvar translate=\"no\"\u003epageToken\u003c/var\u003e is absent, the \u003cvar translate=\"no\"\u003elimit\u003c/var\u003e most recent data points will be returned. |\n| `pageToken` | `string` | The continuation token, which is used to page through large datasets. To get the next page of a dataset, set this parameter to the value of `nextPageToken` from the previous response. Each subsequent call will yield a partial dataset with data point end timestamps that are strictly smaller than those in the previous partial response. |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes:\n\n| Scope |\n|---------------------------------------------------------------------|\n| `https://www.googleapis.com/auth/fitness.activity.read` |\n| `https://www.googleapis.com/auth/fitness.activity.write` |\n| `https://www.googleapis.com/auth/fitness.location.read` |\n| `https://www.googleapis.com/auth/fitness.location.write` |\n| `https://www.googleapis.com/auth/fitness.body.read` |\n| `https://www.googleapis.com/auth/fitness.body.write` |\n| `https://www.googleapis.com/auth/fitness.nutrition.read` |\n| `https://www.googleapis.com/auth/fitness.nutrition.write` |\n| `https://www.googleapis.com/auth/fitness.blood_pressure.read` |\n| `https://www.googleapis.com/auth/fitness.blood_pressure.write` |\n| `https://www.googleapis.com/auth/fitness.blood_glucose.read` |\n| `https://www.googleapis.com/auth/fitness.blood_glucose.write` |\n| `https://www.googleapis.com/auth/fitness.oxygen_saturation.read` |\n| `https://www.googleapis.com/auth/fitness.oxygen_saturation.write` |\n| `https://www.googleapis.com/auth/fitness.body_temperature.read` |\n| `https://www.googleapis.com/auth/fitness.body_temperature.write` |\n| `https://www.googleapis.com/auth/fitness.reproductive_health.read` |\n| `https://www.googleapis.com/auth/fitness.reproductive_health.write` |\n\nFor more information, see the [authentication and authorization](/fit/rest/v1/authorization) page.\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [Users.dataSources.datasets resource](/fit/rest/v1/reference/users/dataSources/datasets#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
