Get Nutrition Time Series by Date Range

Retrieves the food and water consumption data for a given resource over a period of time by specifying a date range. The response will include only the daily summary values.

Scope: nutrition

Request

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

URI Arguments

user-id	required	The encoded ID of the user. Use "-" (dash) for current logged-in user.
resource	required	The resource of the data to be returned. Supported: `caloriesIn` \| `water`
start-date	required	The start date specified in the format `yyyy-MM-dd` or `today`.
end-date	required	The end date specified in the format `yyyy-MM-dd` or `today`. Maximum range: `1095 days`

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

URL
CURL

GET https://api.fitbit.com/1/user/-/foods/log/water/date/2019-03-15/2019-03-21.json
GET https://api.fitbit.com/1/user/GGNJL9/foods/log/water/date/2019-03-15/2019-03-21.json

curl -X GET "https://api.fitbit.com/1/user/-/foods/log/water/date/2019-03-15/2019-03-21.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Element Name	Description
foods-log- : dateTime	The date representing the daily summary value of the resource.
foods-log- : value	The total daily consumption for the resource.

{
  "foods-log-water": [
    {
      "dateTime": "2019-03-15",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-16",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-17",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-18",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-19",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-20",
      "value": "0.0"
    },
    {
      "dateTime": "2019-03-21",
      "value": "1892.7099609375"
    }
  ]
}

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

The data will be returned in the format requested using the units in the unit system that corresponds to the Accept-Language header provided.

Note: If you provided earlier dates in the request, the response will retrieve only data since the user's join date or the first log entry date for the requested collection.

Get Nutrition Time Series by Date