Google Health API reference

Irregular Rhythm Notification: the Google Health API irregular-rhythm-notification data type

Read from Google’s documentation on 2026-10-17 · discovery document revision 20261014 · Google’s data-types page last updated 2026-10-06

Irregular Rhythm Notification (irregular-rhythm-notification) is a Session data type in the Google Health API. Google's data-types table lists list for it under the .irn.readonly scope. The table marks it with neither webhook nor true-zeros support. Google's Fitbit migration table maps the Fitbit Web API's Irregular Rhythm Notifications (IRN) data to it.

Irregular Rhythm Notification at a glance

From the Irregular Rhythm Notification row of Google’s data-types table, joined to the discovery document’s DataPoint schema.

Display name: Irregular Rhythm Notification
dataType (in endpoint URLs): irregular-rhythm-notification
filter parameter: irregular_rhythm_notificationGoogle: “The identifier separated by underscores (for example, active_minutes) used as the value for the dataType filter parameter in daily rollup and rollup requests.”
Record type: Session — Google: “Represents a continuous block of recording, such as a workout or an electrocardiogram (ECG) session.”
Storage resolution: not stated in Google’s table
Webhook support: Not marked in Google’s table
True zeros support: Not marked in Google’s table
Channel: v4
DataPoint field: DataPoint.irregularRhythmNotification → IrregularRhythmNotificationIts description: “Optional. Data for points in the irregular-rhythm-notification session data type collection.”
Compatible devices: 0 in Google’s table

Operations and request paths

The operations Google’s table lists for irregular-rhythm-notification, each matched to its users.dataTypes.dataPoints method in the discovery document. The path is the documented path template (the method’s flatPath on https://health.googleapis.com/) with {dataTypesId} filled in as irregular-rhythm-notification. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Table lists	Method	Documented path template
`list`	`list`	`GET https://health.googleapis.com/v4/users/{usersId}/dataTypes/irregular-rhythm-notification/dataPoints`

Every method, and how many of the data types list it: the methods overview.

Scopes

The scopes Google’s table lists for irregular-rhythm-notification, as full URLs, with the consent text Google’s Scopes page gives each. Every Google Health API scope.

Scope	Access	Google’s permission text
`https://www.googleapis.com/auth/googlehealth.irn.readonly`	read	See your Google Health Irregular Rhythm Notifications data.

Fields of Irregular Rhythm Notification

The schema the discovery document gives DataPoint.irregularRhythmNotification, required fields first. Types are as the discovery document states them; the label is the word Google’s description opens with. The schemas its fields refer to follow, one level deep.

IrregularRhythmNotification — Google: “Represents an Irregular Rhythm Notification alert, indicating a potential sign of atrial fibrillation (AFib). This data type is based on SaMD feature and any changes to it may require additional review.”

Field	Type	Google’s description
`interval`Required	`SessionTimeInterval`	Required. Observed interval.
`alertWindows`Optional	`array<AlertWindow>`	Optional. The overlapping analysis windows that were used to evaluate rhythm for potential AFib, containing specific information about the user's heart rhythm.
`medicalDeviceInfo`Output only	`MedicalDeviceInfo`	Output only. The meta information for the compatible device used to conduct the measurement. Irregular Rhythm Notification measurements typically populate `algorithm_version`, `service_version`, and `device_model`.

`SessionTimeInterval`

Google: “Represents a time interval of session data point, which bundles multiple observed metrics together.”

Field	Type	Google’s description
`endTime`Required	`string/google-datetime`	Required. The end time of the observed session.
`endUtcOffset`Required	`string/google-duration`	Required. The offset of the user's local time at the end of the session relative to the Coordinated Universal Time (UTC).
`startTime`Required	`string/google-datetime`	Required. The start time of the observed session.
`startUtcOffset`Required	`string/google-duration`	Required. The offset of the user's local time at the start of the session relative to the Coordinated Universal Time (UTC).
`civilEndTime`Output only	`CivilDateTime`	Output only. Session end time in civil time in the timezone the subject is in at the end of the session.
`civilStartTime`Output only	`CivilDateTime`	Output only. Session start time in civil time in the timezone the subject is in at the start of the session.

`AlertWindow`

Google: “An analysis window evaluated for AFib. Note: The current version of the algorithm will only produce alerts if all windows are positive. So anything returned from the API will always have the positive bit set to true. Internally, windows can be negative, however. We never save "inconclusive" windows (they aren't produced by the algorithm).”

Field	Type	Google’s description
`endTime`Required	`string/google-datetime`	Required. The end time of the analysis window.
`endUtcOffset`Required	`string/google-duration`	Required. The UTC offset of the user's timezone when the analysis window ended.
`startTime`Required	`string/google-datetime`	Required. Observed interval. The start time of the analysis window.
`startUtcOffset`Required	`string/google-duration`	Required. The UTC offset of the user's timezone when the analysis window started.
`civilEndTime`Output only	`CivilDateTime`	Output only. Observed interval end time in civil time in the timezone the subject is in at the end of the observed interval
`civilStartTime`Output only	`CivilDateTime`	Output only. Observed interval start time in civil time in the timezone the subject is in at the start of the observed interval
`heartBeats`Optional	`array<HeartBeat>`	Optional. All heart beats in the interval contained in this analysis window.
`positive`Optional	`boolean`	Optional. Flag indicating whether the window was positive for AFib or not. A `true` value indicates that AFib was detected in this window. A `false` value means AFib was not detected, but does not guarantee the absence of AFib.

`MedicalDeviceInfo`

Google: “Software as Medical Device (SaMD) metadata. Used to construct the Unique Device Identifier (UDI).”

Field	Type	Google’s description
`algorithmVersion`Output only	`string`	Output only. The algorithm version used by the feature.
`deviceModel`Output only	`string`	Output only. The model name or device type of the compatible device used to collect the data.
`featureVersion`Output only	`string`	Output only. The version of the feature/app running on the device.
`firmwareVersion`Output only	`string`	Output only. The firmware version running on the compatible device used to collect the data.
`serviceVersion`Output only	`string`	Output only. The service version used by the feature.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table maps Irregular Rhythm Notifications (IRN) to irregular-rhythm-notification.

Fitbit Web API scopes Google maps to irregular-rhythm-notification’s scopes: irregular_rhythm_notifications.

Google’s full Fitbit Web API mapping tables · the migration playbook

Google’s documentation

Related on this site

ECG API: Electrocardiogram and Irregular Rhythm Data — the metric on every platform this site covers, each type quoted in its platform's own words
Verification and rate limits
The Fitbit Web API turn-off

Questions

Which OAuth scopes does the Google Health API irregular-rhythm-notification data type need?

Google's data-types table (read 2026-10-17) lists https://www.googleapis.com/auth/googlehealth.irn.readonly for irregular-rhythm-notification. The Scopes page's consent text: .irn.readonly, "See your Google Health Irregular Rhythm Notifications data."

Can apps write irregular rhythm notification data to the Google Health API?

Not according to Google's data-types table, read 2026-10-17: it lists only list for irregular-rhythm-notification, and no create, update or batchDelete operation.

How do you aggregate irregular-rhythm-notification data with the Google Health API?

Not with rollUp or dailyRollUp, going by Google's data-types table: it lists only list for irregular-rhythm-notification. Read the data points with list (or reconcile, where listed) and compute any summary yourself.

What did the Google Health API irregular-rhythm-notification data type replace in the Fitbit Web API?

Google's Fitbit Web API migration table maps the Fitbit Web API's "Irregular Rhythm Notifications (IRN)" to irregular-rhythm-notification. The Fitbit Web API scope Google maps to its scopes: irregular_rhythm_notifications.

Sources checked

Google Health API data types — last updated 2026-10-06 · read 2026-10-17
Google Health API discovery document (v4) — revision 20261014 · read 2026-10-17
Scopes — last updated 2026-10-09 · read 2026-10-17
API specifications — last updated 2026-09-22 · read 2026-10-17

Google’s text is quoted for identification; each guide page’s footer reads: “Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License.”. Generated from Google’s pages by scripts/fetch-google-health-api.mjs, not typed by hand; Google’s documentation remains the authority.

← All Google Health API data types