Create Body Fat Log
Creates a body fat log entry.
Scope: weight
Request
| POST | /1/user/[user-id]/body/log/fat.json |
URI Arguments
| user-id | required | The encoded ID of the user. Use "-" (dash) for current logged-in user. |
Query Parameters
| fat | required | Body fat measurement in the format X.XX. | decimal |
| date | required | The date the body fat measurement was recorded in the format yyyy-MM-dd. | string ($date) |
| time | optional | The timestamp the body fat measurement was recorded in the format HH:mm:ss. If a value is not provided, the timestamp will be the last second of the day. | string ($time) |
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. |
| content-length | required | According to RFC 7230, section 3.3.2, this HTTP request requires the Content-Length header field containing the anticipated size of the payload body. |
Examples
POST https://api.fitbit.com/1/user/-/body/log/fat.json?fat=15&date=2019-03-20&time=08:15:00
POST https://api.fitbit.com/1/user/GGNJL9/body/log/fat.json?fat=15&date=2019-03-20&time=08:15:00
POST https
curl -X POST "https://api.fitbit.com/1/user/-/body/log/fat.json?fat=15&date=2019-03-20&time=08%3A15%3A00" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>" \
-H "content-length: <message_body_size>"
-H "accept: application/json" \
-H "authorization: Bearer <access_token>" \
-H "content-length: <message_body_size>"
Response
| Element Name | Description |
| fatLog : date | The date the body fat log was recorded. |
| fatLog : fat | The body fat percentage. |
| fatLog : logId | The body fat log Id. Note: The returned Body Fat Log IDs are unique to the user, but not globally unique. |
| fatLog : source | The location where the body fat data originated. See
"source" values
for more information. Support: API | Aria |
AriaAir | Withings |
| fatLog : time | The timestamp when the body fat log was recorded. |
{
"fatLog": {
"date": "2019-03-20",
"fat": 15,
"logId": 1553069700000,
"source": "api",
"time": "08:15:00"
}
}
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
| 201 | 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:
- 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.
- Aria: The weight and/or body fat data originated from an Aria or Aria 2 scale.
- AriaAir: The weight and/or body fat data originated from an Aria Air scale.
- Withings: The weight and/or body fat data originated from a Withings scale.
