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

Get Body Fat Time Series by Date

Retrieves a list of all user's body fat log entries for a given period.

Scope: weight

Request

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

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
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, or max are not supported.

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/log/fat/date/2019-02-20/7d.json
GET https://api.fitbit.com/1/user/GGNJL9/body/log/fat/date/2019-02-20/7d.json
curl -X GET "https://api.fitbit.com/1/user/-/body/log/fat/date/2019-02-20/7d.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

Element Name Description
fat : date The date the body fat log was recorded.
fat : fat The body fat percentage.
fat : logId The body fat log Id.
fat : source The location where the body fat data originated. See "source" values for more information.

Support: API | Aria | AriaAir | Withings
fat : time The timestamp when the body fat log was recorded. 
{
  "fat": [
    {
      "date": "2018-02-21",
      "fat": 15.5,
      "logId": 1532187349000,
      "source": "Aria",
      "time": "15:35:49"
    },
    {
      "date": "2018-02-23",
      "fat": 16.1,
      "logId": 1532333041000,
      "source": "Aria",
      "time": "08:04:01"
    },
    {
      "date": "2018-02-26",
      "fat": 16.8,
      "logId": 1532586869000,
      "source": "Aria",
      "time": "06:34:29"
    },
    {
      "date": "2018-02-26",
      "fat": 17.2,
      "logId": 1532586900000,
      "source": "Aria",
      "time": "06:35:00"
    },
    {
      "date": "2018-02-26",
      "fat": 17.5,
      "logId": 1532586936000,
      "source": "Aria",
      "time": "06:35:36"
    },
    {
      "date": "2018-07-27",
      "fat": 17.4,
      "logId": 1532677290000,
      "source": "Aria",
      "time": "07:41:30"
    },
    {
      "date": "2018-03-01",
      "fat": 16.5,
      "logId": 1532748067000,
      "source": "Aria",
      "time": "03:21:07"
    }
  ]
}

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

"source" values

This field returns information on whether the user’s body fat or weight data was automatically or manually entered. It includes the following values:

  1. API: The weight and/or body fat data originated from a 3rd party integration using the Web API, the data was manually entered into the Fitbit mobile or web application, or the data recorded by a predefined scale was manually edited.
  2. Aria: The weight and/or body fat data originated from an Aria or Aria 2 scale.
  3. AriaAir: The weight and/or body fat data originated from an Aria Air scale.
  4. Withings: The weight and/or body fat data originated from a Withings scale.
previous
Get Body Time Series by Date Range
Get Body Fat Time Series by Date Range
next