BasalBodyTemperatureRecord: Health Connect basal body temperature data
Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24
BasalBodyTemperatureRecord is Health Connect's basal body temperature record — an Instantaneous record in Google's Cycle Tracking category. Its read permission is android.permission.health.READ_BASAL_BODY_TEMPERATURE; its write permission is android.permission.health.WRITE_BASAL_BODY_TEMPERATURE. Google's reference defines no aggregate metrics on it, so it is read with readRecords rather than aggregate. Mandatory fields per Google's table: temperature, measurementLocation, metadata and time.
What Google says BasalBodyTemperatureRecord is
Captures the body temperature of a user when at rest (for example, immediately after waking up). Can be used for checking the fertility window. Each data point represents a single instantaneous body temperature measurement.
Quoted from Google’s BasalBodyTemperatureRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.
- Class
androidx.health.connect.client.records.BasalBodyTemperatureRecord- Google's category
- Cycle Tracking
- Record type
- Instantaneous
- Unit class
androidx.health.connect.client.units.Temperature- Mandatory fields
temperaturemeasurementLocationmetadatatime- Added in (Jetpack)
1.1.0
Permissions
The exact strings Google’s data-types table declares for BasalBodyTemperatureRecord. 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_BASAL_BODY_TEMPERATURE | API 34 · U Ext 7 |
| Write | android.permission.health.WRITE_BASAL_BODY_TEMPERATURE | API 34 · U Ext 7 |
<uses-permission android:name="android.permission.health.READ_BASAL_BODY_TEMPERATURE" />
<uses-permission android:name="android.permission.health.WRITE_BASAL_BODY_TEMPERATURE" />import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.BasalBodyTemperatureRecord
val permissions = setOf(
HealthPermission.getReadPermission(BasalBodyTemperatureRecord::class),
HealthPermission.getWritePermission(BasalBodyTemperatureRecord::class),
)The 5 fields of BasalBodyTemperatureRecord
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 |
|---|---|---|---|
measurementLocationmandatory= BodyTemperatureMeasurementLocation.MEASUREMENT_LOCATION_UNKNOWN | Int | — | Where on the user's basal body the temperature measurement was taken from. Optional field. Allowed values: BodyTemperatureMeasurementLocation. |
metadatamandatory | Metadata | — | Set of common metadata associated with the written record. |
temperaturemandatory | Temperature | Valid range: 0-100 Celsius degrees. | Temperature in Temperature unit. Required field. Valid range: 0-100 Celsius degrees. |
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. |
Read BasalBodyTemperatureRecord in Kotlin
The shape of Google’s own read example, with BasalBodyTemperatureRecord 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.BasalBodyTemperatureRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
suspend fun readBasalBodyTemperature(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): List<BasalBodyTemperatureRecord> {
val response = client.readRecords(
ReadRecordsRequest(
BasalBodyTemperatureRecord::class,
timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
)
)
// One page of up to pageSize records (default 1000); follow
// response.pageToken for the rest.
return response.records
}Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.
HealthKit counterpart
No verified HealthKit counterpart. The cross-platform matrix only pairs metrics checked against both Apple’s and Google’s documentation, and BasalBodyTemperatureRecord is not among them yet. A similarly named Apple type may exist on the HealthKit reference, but a name match is not a verified mapping.
The metric on other platforms
These guides list BasalBodyTemperatureRecord 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 BasalBodyTemperatureRecord need?
- Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_BASAL_BODY_TEMPERATURE for reading BasalBodyTemperatureRecord and android.permission.health.WRITE_BASAL_BODY_TEMPERATURE for writing it, and says apps must declare permissions in the manifest before requesting them.
- Can you aggregate BasalBodyTemperatureRecord with AggregateRequest?
- Not directly. As read on 2026-10-03, Google's Jetpack reference defines no AggregateMetric constants on BasalBodyTemperatureRecord, so there is no metric to put in an AggregateRequest. Read the records with readRecords and a ReadRecordsRequest, and compute any summary yourself.
- What values does BasalBodyTemperatureRecord.temperature accept?
- Google's reference types temperature as Temperature. Its description reads: "Temperature in Temperature unit. Required field. Valid range: 0-100 Celsius degrees."
- Is BasalBodyTemperatureRecord an interval, instantaneous or series record?
- Google's data-types table lists BasalBodyTemperatureRecord 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 temperature, measurementLocation, metadata and time.
Other Cycle Tracking records
Sources checked
- Google — BasalBodyTemperatureRecord (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.