Get Body Time Series by Date
chevron down
back search icon cancel search
 
 

Get Body Time Series by Date

Retrieves a list of all user's bmi, body fat, or weight for a given period.

Scope: weight

Request

GET /1/user/[user-id]/body/[resource]/date/[date]/[period].json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
resource required The body resource to be returned.
Supported: bmi | fat | weight
date required The end date of the period specified in the format yyyy-MM-dd or today.
period required The range for which data will be returned.

Supported: 1d | 7d | 30d | 1w | 1m | 3m | 6m | 1y | max

Request Headers
authorization required Specify the token type and Fitbit user’s access token.
Token type: Bearer
accept optional The media type of the response content the client is expecting.
Supported: application/json
accept-language optional The measurement unit system to use for response values. See Localization.
accept-locale optional The locale to use for response values. See Localization.

Examples
GET https://api.fitbit.com/1/user/-/body/weight/date/today/7d.json
GET https://api.fitbit.com/1/user/GGNJL9/body/weight/date/today/7d.json
curl -X GET "https://api.fitbit.com/1/user/-/body/weight/date/today/7d.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

Element Name Description
body-<resource> : datetime The datetime which the resource was recorded.
body-<resource> : value The value of the resource. 
{
  "body-weight": [
    {
      "dateTime": "2019-03-13",
      "value": "170"
    },
    {
      "dateTime": "2019-03-14",
      "value": "171"
    },
    {
      "dateTime": "2019-03-15",
      "value": "170"
    },
    {
      "dateTime": "2019-03-16",
      "value": "172"
    },
    {
      "dateTime": "2019-03-17",
      "value": "171"
    },
    {
      "dateTime": "2019-03-18",
      "value": "171"
    },
    {
      "dateTime": "2019-03-19",
      "value": "171"
    }
  ]
}

Response Headers
content-type The media type of the response content being sent to the client.
Supported: application/json
fitbit-rate-limit-limit The quota number of calls.
fitbit-rate-limit-remaining The number of calls remaining before hitting the rate limit.
fitbit-rate-limit-reset The number of seconds until the rate limit resets.
Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.

Response Type
HTTP Status Code HTTP response code. List of codes are found in the Troubleshooting Guide.
Status Message Description of the status code.
Response Body Contains the JSON response to the API call. When errors are returned by the API call, the errorType, fieldName and message text will provide more information to the cause of the failure.

Response Codes
200 A successful request.
400 The request had bad syntax or was inherently impossible to be satisfied.
401 The request requires user authentication.
Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Additional Information

Data is returned using units in the unit systems that corresponds to the Accept-Language header provided.
Note: If you provide earlier dates in the request, the response retrieves only data since the user's join date or the first log entry date for the requested collection.
Get Body Time Series by Date Range
next