Get AZM Time Series by Interval
chevron down
back search icon cancel search
 
 

Get AZM Time Series by Interval

This endpoint returns the daily summary values over an interval by specifying a date range.

Scope: activity

Request

GET /1/user/[user-id]/activities/active-zone-minutes/date/[start-date]/[end-date].json

URI Arguments
user-id required The encoded ID of the user. Use "-" (dash) for current logged-in user.
start-date required The date in the format yyyy-MM-dd or today.
end-date required The date 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
GET https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/2022-05-02/2022-05-02.json
GET https://api.fitbit.com/1/user/GGNJL9/activities/active-zone-minutes/date/2022-05-02/2022-05-02.json
curl -X GET "https://api.fitbit.com/1/user/-/activities/active-zone-minutes/date/2022-05-01/2022-05-02.json" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

Element Name Description
dateTime The date specified in the format YYYY-MM-DD or today.
value : activeZoneMinutes Total count of active zone minutes.
value : fatBurnActiveZoneMinutes The number of active zone minutes in the fat burn heart rate zone. 1 fat burn minute = 1 fat burn active zone minute.
value : cardioActiveZoneMinutes The number of active zone minutes in the cardio heart rate zone. 1 cardio minute = 2 cardio active zone minutes.
value : peakActiveZoneMinutes The number of active zone minutes in the peak heart rate zone. 1 peak minute = 2 peak active zone minutes. 
{
  "activities-active-zone-minutes": [
    {
      "dateTime": "2022-05-01",
      "value": {
        "activeZoneMinutes": 21,
        "fatBurnActiveZoneMinutes": 5,
        "cardioActiveZoneMinutes": 12,
        "peakActiveZoneMinutes": 4
      }
    },
    {
      "dateTime": "2022-05-02",
      "value": {
        "activeZoneMinutes": 25,
        "fatBurnActiveZoneMinutes": 7,
        "cardioActiveZoneMinutes": 18,
        "peakActiveZoneMinutes": 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
403 This application does not have permission to [access-type] [resource-type] data

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

Additional Information

Subscription Support for AZM

Active Zone Minutes does not support subscription notifications (webhooks). Since AZM is recorded during normal activity, the activity notification arrival time can be used to estimate when changes to the AZM data is available.

Rate limit

The AZM endpoints are bound by our standard rate limit. See Rate Limits.

Device compatibility

AZM data is retrieved from the user’s Fitbit account. This gives the user secure and transparent control over their data. The data is then processed and made available through the API after the user syncs their device with the Fitbit data service.

Most of the current devices sold support AZM data collection. See the Fitbit Product page to determine if your specific device supports AZM.

previous
Get AZM Time Series by Date