Get Food Log
chevron down
back search icon cancel search
 
 

Get Food Log

Retrieves a summary of the user's food log entry for a given day.

Scope: nutrition

Request

GET /1/user/[user-id]/foods/log/date/[date].json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
date required The date of records to be returned in the format yyyy-MM-dd.

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

Response

Element Name Description
foods : isFavorite
foods : logDate
foods : logId
foods : loggedFood : accessLevel
foods : loggedFood : amount
foods : loggedFood : brand
foods : loggedFood : calories
foods : loggedFood : foodId
foods : loggedFood : locale
foods : loggedFood : mealTypeId
foods : loggedFood : name
foods : loggedFood : unit : id
foods : loggedFood : unit : name
foods : loggedFood : unit : plural
foods : loggedFood : units
foods : nutritionalValues Available nutritional values for the food consumed.
goals : calories Daily calories goal.
summary Total nutritional values consumed in a day. 
{
  "foods": [
    {
      "isFavorite": true,
      "logDate": "2019-03-21",
      "logId": 17406206369,
      "loggedFood": {
        "accessLevel": "PUBLIC",
        "amount": 1,
        "brand": "Subway",
        "calories": 280,
        "foodId": 14022778,
        "locale": "en_US",
        "mealTypeId": 3,
        "name": "6 inch Turkey Breast",
        "unit": {
          "id": 296,
          "name": "sandwich",
          "plural": "sandwiches"
        },
        "units": [
          296,
          226,
          180,
          147,
          389
        ]
      },
      "nutritionalValues": {
        "calories": 280,
        "carbs": 46,
        "fat": 3.5,
        "fiber": 5,
        "protein": 18,
        "sodium": 760
      }
    }
  ],
  "goals": {
    "calories": 2910
  },
  "summary": {
    "calories": 280,
    "carbs": 46,
    "fat": 3.5,
    "fiber": 5,
    "protein": 18,
    "sodium": 760,
    "water": 0
  }
}

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

Access Levels

There are 2 access level types for food log entries that an authorized user can view via API requests. Each food is annotated with an accessLevel field with one of the following values:

  • PUBLIC - Foods that are in Fitbit's public food database and are visible to any Fitbit users. Only Fitbit populates this database to avoid spam and duplicate entries.
  • PRIVATE - Foods created by a user either on the website or via the Create Food endpoint.

Considerations

  1. The units field contains references to respective Food Units.
  2. The accessLevel field can be PUBLIC or PRIVATE. Sharing custom foods is not supported.
  3. The mealTypeId field is always 7 (Anytime). Meals are not associated with particular times.
previous
Get Food Locales
Get Food Units
next