Get AZM Intraday by Interval
This endpoint retrieves the active zone minute (AZM) intraday time series data on a specific date range or 24 hour period. Intraday support can extend the detail-level response to include 1min, 5min and 15min for Active Zone Minutes. 3rd-party developers who want access to retrieve other Fitbit users’ Intraday data through the “Client” or “Server” application type should submit a request by filling out this form. A Fitbit developer’s personal Intraday data is automatically available through the “Personal” application type. You do not need to submit a request.
Scope: activity
Request
| GET |
/1/user/[user-id]/activities/active-zone-minutes/date/[start-date]/[end-date]/[detail-level].json /1/user/[user-id]/activities/active-zone-minutes/date/[start-date]/[end-date]/[detail-level]/time/[start-time]/[end-time].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: 24 hours |
| detail-level | required | Number of data points to include. Supported: 1min | 5min |
15min |
| start-time | optional | The time in the format HH:mm. |
| end-time | optional | The time in the format HH:mm. |
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
GET https
GET https
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
curl -X GET "https
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
Response
| Element Name | Description |
| dateTime | The date specified in the format YYYY-MM-DD. |
| minutes : minute | The datetime when the AZM value was recorded. |
| minutes : value : fatBurnActiveZoneMinutes | The number of active zone minutes in the fat burn heart rate zone earned during the previous iteration. 1 fat burn minute = 1 fat burn active zone minute. |
| minutes : value : cardioActiveZoneMinutes | The number of active zone minutes in the cardio heart rate zone earned during the previous iteration. 1 cardio minute = 2 cardio active zone minute. |
| minutes : value : peakActiveZoneMinutes | The number of active zone minutes in the peak heart rate zone earned during the previous iteration. 1 peak minute = 2 peak active zone minute. |
| minutes : value : activeZoneMinutes | Total count of active zone minutes earned during the previous iteration. |
{
"activities-active-zone-minutes-intraday": [
{
"dateTime": "2020-09-17",
"minutes": [
{
"minute": "2020-09-17T17:15:00",
"value": {
"fatBurnActiveZoneMinutes": 1,
"cardioActiveZoneMinutes": 2,
"peakActiveZoneMinutes": 2,
"activeZoneMinutes": 5
}
},
{
"minute": "2020-09-17T17:30:00",
"value": {
"fatBurnActiveZoneMinutes": 2,
"cardioActiveZoneMinutes": 1,
"activeZoneMinutes": 3
}
}
]
},
.
.
.
{
"dateTime": "2020-09-18",
"minutes": [
{
"minute": "2020-09-18T10:00:00",
"value": {
"fatBurnActiveZoneMinutes": 3,
"cardioActiveZoneMinutes": 3,
"activeZoneMinutes": 6
}
}
]
}
]
}
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
Intraday data response frequency
Active Zone Minute response data is returned every 1 minute, 5 minutes or 15 minutes. This applies exclusively to the intraday endpoints.
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.
