Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Fitbit Irregular Rhythm Notifications (IRN) Export Format

The Irregular Rhythm Notifications (IRN) export provides data regarding the participant's engagement with the Fitbit IRN feature and the alerts received. There are two different IRN endpoints:

  • IRN Profile
  • IRN Alerts List

The data in the Fitbit export is obtained through the Fitbit API. The available data will vary based on the device capabilities and the user's privacy settings. See the Fitbit "Irregular Rhythm Notifications" documentation for more information about using and interpreting Fitbit data.

In order for IRNs to be sent via the Fitbit API, participants must open up the Fitbit app and acknowledge them first.

 

IRN Profile Data Fields

Field Description
FitbitIrnProfileKey Unique key value for the IRN profile record.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
ParticipantIdentifier The MyDataHelps Designer identifier of the participant associated with the Fitbit user. Can be used to cross reference with Participants.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.
Onboarded Whether or not the user has onboarded onto the IRN feature.
Enrolled Whether or not the user is currently enrolled in having their data processed for IRN alerts.
LastUpdated The timestamp of the last piece of analyzable data synced by the user (displayed as local time)

 

IRN Alerts Data Fields

Field Description
FitbitIrnAlertKey Unique key value for the IRN alert record.
ParticipantID The stable, automatically generated, internal system identifier for this participant. Universally unique identifier (UUID).
ParticipantIdentifier The MyDataHelps Designer identifier of the participant associated with the Fitbit user. Can be used to cross reference with Participants.
InsertedDate The creation date of the entry, in ISO 8601 format. Is always in UTC.
AlertTime The start time for the irregular rhythm detection.
DetectedTime The end time for the irregular rhythm detection.
ServiceVersion The version of the service running when the alert was produced.
AlgoVersion The version of the algorithm running when the alert was produced.
DeviceType The name of the device who generated the alert.
StartTime The start time for the analyzable window (representing 5 consecutive minutes of data following the start time).
Time The timestamp of the individual heart beat.
Value The extrapolated bpm value from the individual heart beat.

Sample CSV Exports

FitbitIrnProfile

FitbitIrnProfileKey,ParticipantID,ParticipantIdentifier,InsertedDate,Onboarded,Enrolled,LastUpdated
568c89b4a00cef11a1bbd4d853adda9e,568c89b4-a00c-ef11-a1bb-d4d853adda9e,23cbf66e-a00c-ef11-a1bb-d4d853adda9e,2024-09-24T15:22:36Z,True,True,2024-09-10T08:53:33.000

FitbitIrnAlertsList

FitbitIrnAlertKey,ParticipantID,ParticipantIdentifier,InsertedDate,AlertTime,DetectedTime,ServiceVersion,AlgoVersion,DeviceType
568c89b4a00cef11a1bbd4d853adda9e-1664399550,568c89b4-a00c-ef11-a1bb-d4d853adda9e,23cbf66e-a00c-ef11-a1bb-d4d853adda9e,2024-09-24T15:22:40Z,2022-09-28T17:12:30.000,2022-09-28T17:45:00.000,2.2,1.6,Sense

FitbitIrnAlertsList_Windows

FitbitIrnAlertKey,StartTime
568c89b4a00cef11a1bbd4d853adda9e-1664399550,2022-09-28T17:12:30.000

FitbitIrnAlertsList_Windows_BpmData

FitbitIrnAlertKey,StartTime,Time,Value
568c89b4a00cef11a1bbd4d853adda9e-1664399550,2022-09-28T17:12:30.000,2022-09-28T17:12:30.124,73

 

Sample JSON Exports

FitbitIrnProfile

{
    "FitbitIrnProfileKey": "568c89b4a00cef11a1bbd4d853adda9e",
    "ParticipantID": "568c89b4-a00c-ef11-a1bb-d4d853adda9e",
    "ParticipantIdentifier": "23cbf66e-a00c-ef11-a1bb-d4d853adda9e",
    "InsertedDate": "2024-09-24T15:22:36Z",
    "Onboarded": true,
    "Enrolled": true,
    "LastUpdated": "2024-09-10T08:53:33.000"
}

FitbitIrnAlertsList

{
    "FitbitIrnAlertKey": "568c89b4a00cef11a1bbd4d853adda9e-1664399550",
    "ParticipantID": "568c89b4-a00c-ef11-a1bb-d4d853adda9e",
    "ParticipantIdentifier": "23cbf66e-a00c-ef11-a1bb-d4d853adda9e",
    "InsertedDate": "2024-09-24T15:22:40Z",
    "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": [
                {
                    "Time": "2022-09-28T17:12:30.124",
                    "Value": "73"
                }
            ]
        }
    ]
}