RestingHeartRateRecord: Health Connect resting heart rate data
Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24
RestingHeartRateRecord is Health Connect's resting heart rate record — an Instantaneous record in Google's Vitals category. Its read permission is android.permission.health.READ_RESTING_HEART_RATE; its write permission is android.permission.health.WRITE_RESTING_HEART_RATE. It supports 3 aggregate metrics (BPM_AVG, BPM_MAX and BPM_MIN). Mandatory fields per Google's table: beatsPerMinute, metadata and time.
What Google says RestingHeartRateRecord is
Captures the user's resting heart rate. Each record represents a single instantaneous measurement.
Quoted from Google’s RestingHeartRateRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.
- Class
androidx.health.connect.client.records.RestingHeartRateRecord- Google's category
- Vitals
- Record type
- Instantaneous
- Unit class
- none named in Google's table
- Mandatory fields
beatsPerMinutemetadatatime- Added in (Jetpack)
1.1.0
Permissions
The exact strings Google’s data-types table declares for RestingHeartRateRecord. Google’s page: “Before requesting any permissions, your app must declare them in the manifest.”
| Access | Permission string | Framework reference |
|---|---|---|
| Read | android.permission.health.READ_RESTING_HEART_RATE | API 34 · U Ext 7 |
| Write | android.permission.health.WRITE_RESTING_HEART_RATE | API 34 · U Ext 7 |
<uses-permission android:name="android.permission.health.READ_RESTING_HEART_RATE" />
<uses-permission android:name="android.permission.health.WRITE_RESTING_HEART_RATE" />import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.RestingHeartRateRecord
val permissions = setOf(
HealthPermission.getReadPermission(RestingHeartRateRecord::class),
HealthPermission.getWritePermission(RestingHeartRateRecord::class),
)The 4 fields of RestingHeartRateRecord
Types and descriptions as Google’s reference prints them. The range column quotes Google’s own range annotation or sentence; a dash means Google states none, which is not the same as no validation.
| Field | Type | Allowed range | Google’s description |
|---|---|---|---|
beatsPerMinutemandatory | Long | Validation range: 1-300. | Heart beats per minute. Required field. Validation range: 1-300. |
metadatamandatory | Metadata | — | Set of common metadata associated with the written record. |
timemandatory | Instant | — | Time the record happened. |
zoneOffset | ZoneOffset? | — | User experienced zone offset at time, or null if unknown. Providing these will help history aggregations results stay consistent should user travel. Queries with user experienced time filters will assume system current zone offset if the information is absent. |
Aggregate metrics
The AggregateMetric constants Google defines on RestingHeartRateRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.
| Metric | Value type | Google’s description |
|---|---|---|
| RestingHeartRateRecord.BPM_AVG | Long | Metric identifier to retrieve the average resting heart rate from AggregationResult. |
| RestingHeartRateRecord.BPM_MAX | Long | Metric identifier to retrieve the maximum resting heart rate from AggregationResult. |
| RestingHeartRateRecord.BPM_MIN | Long | Metric identifier to retrieve the minimum resting heart rate from AggregationResult. |
Google’s read-data guide: “For cumulative types like StepsRecord, use aggregate() instead of readRecords() to avoid double counting from multiple sources and improve accuracy.” and “The aggregation API also contains logic to handle duplicate records, and lessens the chances of rate limiting.”
Read RestingHeartRateRecord in Kotlin
The shape of Google’s own read example, with RestingHeartRateRecord and its names filled in. Get the client with HealthConnectClient.getOrCreate(context) after checking getSdkStatus.
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.RestingHeartRateRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
suspend fun readRestingHeartRate(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): List<RestingHeartRateRecord> {
val response = client.readRecords(
ReadRecordsRequest(
RestingHeartRateRecord::class,
timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
)
)
// One page of up to pageSize records (default 1000); follow
// response.pageToken for the rest.
return response.records
}import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.RestingHeartRateRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
suspend fun aggregateRestingHeartRate(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): Long? {
val response = client.aggregate(
AggregateRequest(
metrics = setOf(RestingHeartRateRecord.BPM_AVG),
timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
)
)
// get() is declared as returning a nullable value.
return response[RestingHeartRateRecord.BPM_AVG]
}Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.
HealthKit counterpart
RestingHeartRateRecord sits in the verified cross-platform matrix’s Heart rate row, which groups HKQuantityTypeIdentifier.heartRate, .restingHeartRate on Apple with HeartRateRecord, RestingHeartRateRecord on Android. The row groups the metric; it does not pair each Android record with one Apple type.
The Apple types in that row on the HealthKit reference: heartRate, restingHeartRate.
Watch out: Both expose samples plus a separate resting value — don't derive resting yourself.
The metric on other platforms
This guide lists RestingHeartRateRecord beside the types on the other platforms this site covers whose own descriptions name the same metric, each quoted, with how each one is read.
Questions
- What permission does RestingHeartRateRecord need?
- Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_RESTING_HEART_RATE for reading RestingHeartRateRecord and android.permission.health.WRITE_RESTING_HEART_RATE for writing it, and says apps must declare permissions in the manifest before requesting them.
- Which aggregate metrics does RestingHeartRateRecord support?
- Google's Jetpack reference defines 3 on RestingHeartRateRecord: BPM_AVG (AggregateMetric<Long>), BPM_MAX (AggregateMetric<Long>) and BPM_MIN (AggregateMetric<Long>). Pass them in the metrics set of an AggregateRequest and read each back from the AggregationResult.
- What values does RestingHeartRateRecord.beatsPerMinute accept?
- Google's reference types beatsPerMinute as Long. Its description reads: "Heart beats per minute. Required field. Validation range: 1-300."
- Is RestingHeartRateRecord an interval, instantaneous or series record?
- Google's data-types table lists RestingHeartRateRecord as Instantaneous, and defines that column as indicating "whether the data is recorded at an instant in time or over an interval". Its mandatory fields are beatsPerMinute, metadata and time.
Other Vitals records
Sources checked
- Google — RestingHeartRateRecord (Jetpack reference) — last updated 2026-06-24 · read 2026-10-03
- Google — Health Connect data types · read 2026-10-03
- Google — HealthPermissions (framework reference) · read 2026-10-03
- Google — Read raw data (Health Connect guide) · read 2026-10-03
Google’s descriptions are quoted for identification; the page layout, the capsule and the cross-platform pairing are AIFitnessAPI’s. Generated from Google’s pages by a script, not typed by hand — the same data is behind every page in the Health Connect reference.