Get Activity Time Series by Date Range

Retrieves the activity 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: activity

Request

• URL
• CURL

Response

• Description
• Example Response

{
  "activities-steps": [
    {
      "dateTime": "2018-12-26",
      "value": "2504"
    },
    {
      "dateTime": "2018-12-27",
      "value": "3723"
    },
    {
      "dateTime": "2018-12-28",
      "value": "8304"
    },
    {
      "dateTime": "2018-12-29",
      "value": "7861"
    },
    {
      "dateTime": "2018-12-30",
      "value": "837"
    },
    {
      "dateTime": "2018-12-31",
      "value": "4103"
    },
    {
      "dateTime": "2019-01-01",
      "value": "1698"
    }
  ]
}
      

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

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Additional Information

The activity log entries for a given day are displayed in the format requested using units in the unit system corresponding to the Accept-Language header provided.

Considerations

• User data is only available since the user's join date or the first log entry date for the requested collection.
• The tracker/... resource represents the daily activity values logged by the tracker device only, excluding manual activity log entires.
• The tracker/calories resource does not include the Estimated Energy Requirement for calories estimation (EER) calculations for any dates even if they are turned on for the user's profile and use BMR level instead.
• Elevation time series (/elevation, /floors) are only available for users with compatible trackers.
• The activities collection are maintained for backwards compatible resource URLs (e.g. (activities/log/calories)).

Resource Options

Calorie Time Series Differences

• calories - The top level time series for calories burned inclusive of BMR, tracked activity, and manually logged activities.
• caloriesBMR - Value includes only BMR calories.
• activityCalories - The number of calories burned during the day for periods of time when the user was active above sedentary level. This value is calculated minute by minute for minutes that fall within this criteria. This includes activity burned calories and BMR.
• tracker/calories - Calories burned inclusive of BMR according to movement captured by a Fitbit tracker.
• tracker/activityCalories - Calculated similarly to activityCalories, but uses only tracker data. Manually logged activities are excluded.

Distance

Devices that support on-device or connected GPS will record distance when the exercise is initiated using the on-device Exercise application. For auto-detected exercises, we use steps and the stride length of the user to estimate distance. To determine how the exercise was recorded, see the Get Activity Log List response element "logType".

Activity webhook notifications

The Fitbit Web API can send notifications when a Fitbit user has new data to download. This is possible by implementing the Subscription API and subscribing to one or more data collections. See Using Subscriptions. Whenever the activity service recognizes a change to the user’s data, a notification is sent to your application’s subscriber.

The activity collection recognizes changes to a user’s recorded activities, step count, calories burned, distance traveled, etc. Keep in mind that even when a person is not in motion, their body is burning calories. It’s possible to receive activity notifications representing calorie burn even when the user is sleeping or stationary. Today, you cannot subscribe to a subset of the user’s activity data. So, it is the responsibility of your application to query the necessary activity endpoint(s) to reconcile the data in your system.

Get Activity Time Series by Date