Get IRN Alerts List

This endpoint returns a paginated list of Irregular Rhythm Notifications (IRN) alerts, as well as all of the alert tachograms. This endpoint will only return alerts that the user has read in the Fitbit app already, as that is meant as the primary entrypoint for viewing notifications.

Note: The IRN API is for research use or investigational use only, and is not intended for clinical or diagnostic purposes.

Scope: irregular_rhythm_notifications

Request

• URL
• CURL

Response

• Description
• Example Response

{
  "alerts": [
    {
      "alertTime": "2022-09-28T17:12:30.000",
      "detectedTime": "2022-09-28T17:45:00.000",
      "serviceVersion": "2.2",
      "algoVersion": "1.6",
      "deviceType": "Sense",
      "windows": [
        {
          "startTime": "2022-09-28T17:12:30.000",
          "bpmData": [
            {
              "dataTime": "2022-09-28T17:12:30.124",
              "value": 73
            }
          ]
        }
      ]
    }
  ],
  "pagination": {
    "afterDate": "2022-09-28T20:00:00",
    "next": "https://api.fitbit.com/1/user/-/irn/alerts/list.json?offset=0&limit=10&sort=asc&afterDate=2022-09-28T21:00:00",
    "previous": "",
    "sort": "asc",
    "limit": 1,
    "offset": 0
  }
}
      

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

Alert Filtering

We will only reveal AFib alerts that have been opened by the user in the Fitbit app. See How do Fitbit Irregular Rhythm Notifications check for atrial fibrillation (AFib)? It is important that the user is first aware of this notification and understands its importance to their health. The app explains to the user what an IRN is and that the notification is not a diagnosis. Once the user interacts with the notification, the information is shared via API.

Limit / Offset

The IRN data set is very large. Because of this, we cannot query and return large numbers of IRN results, and limit the number of results to 10. The offset query parameter is not fully supported and its future is unknown. Therefore, the only supported value is 0. Using the "offset" query parameter in any other capacity could cause your application to break.

To paginate, request the next and previous links in the pagination response object. The next and previous link should include afterDate or beforeDate parameters of the datetime for the last reading in each page.

Subscription Support for IRN

IRN does not support subscription notifications (webhooks). We recommend querying IRN data once or twice a day to determine if new data is available (e.g. 12 noon and midnight). However, the frequency or rate at which you query IRN data should be based on your specific use cases and with this in mind.

Rate limit

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

Device compatibility

The IRN 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 IRN data collection. See the Fitbit Product page to determine if your specific device supports IRN.

Get IRN Profile