Create Activity Log

Creates a log entry containing the Fitbit user's activity or private custom activity.

Scope: activity

Request

• URL
• CURL

Response

• Description
• Example Response

{
  "activityLog": {
    "activityId": 90013,
    "activityParentId": 90013,
    "activityParentName": "Walk",
    "calories": 300,
    "description": "Walking less than 2 mph, strolling very slowly",
    "distance": 2,
    "duration": 6000000,
    "hasActiveZoneMinutes": true,
    "hasStartTime": true,
    "isFavorite": false,
    "lastModified": "2023-06-05T18:39:39.035Z",
    "logId": 56268507015,
    "name": "Walk",
    "startDate": "2023-06-01",
    "startTime": "10:30",
    "steps": 2706
  }
}
        

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.

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

Additional Information

This endpoint uses the units in the unit system which corresponds to the Accept-Language header provided (or using optional custom distanceUnit) and sends a JSON response in the format requested.

When specifying the startTime parameter value, do not include seconds. Seconds is not a supported value and will return incorrect data when it is included.

Activity Types

Any activity log entry is based on one of the activities from the catalog of activities. Though activities in catalog have a tree structure (i.e. divided into categories like "Sports and Workouts", "Running" and subcategories like "Bicycling", "Walking"), each activity leaf in the catalog can also have more granular structure. Each leaf can have a directory activity type (and have child intensity levels) or simple activity (have no levels). When creating a new activity log entry, use the following types of objects to pass as the activityId value:

• Directory activity id: activity contains child activities which represents intensity levels (e.g. "Running").
• Intensity level id: activity within directory activity (e.g. "Running/6.7mph (9 min/mile)").
• Simple activity id: single activity without intensity levels (e.g. "Shoveling snow").

Note: A list of activities can be retrieved via the Browse Activities endpoint.

Custom Activities

In the process of creating a new activity log entry, it is possible to seamlessly create a new custom activity for the user. This can be achieved by using the second scenario for the set of POST parameters (providing activityName instead of activityId). In this case, either existing custom activity with the same name will be used for creating new log entry or a new record created and then logged. As for custom activities on the website, manualCalories must always provided with the activityName parameter among other required fields.

Note: "Steps" may be used as a distanceUnits value when the activity is either "Walking" (activityId=90013) or "Running" (activityId=90009) and distance is only included when it is relevant.

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.

Create Activity Goal

Create Favorite Activity