Skip to content
AF
Health Connect reference

HeightRecord: Health Connect height data

Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24

HeightRecord is Health Connect's height record — an Instantaneous record in Google's Body Measurement category. Its read permission is android.permission.health.READ_HEIGHT; its write permission is android.permission.health.WRITE_HEIGHT. It supports 3 aggregate metrics (HEIGHT_AVG, HEIGHT_MAX and HEIGHT_MIN). Mandatory fields per Google's table: height, metadata and time.

What Google says HeightRecord is

Captures the user's height.

Quoted from Google’s HeightRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.

Class
androidx.health.connect.client.records.HeightRecord
Google's category
Body Measurement
Record type
Instantaneous
Unit class
androidx.health.connect.client.units.Length
Mandatory fields
heightmetadatatime
Added in (Jetpack)
1.1.0

Permissions

The exact strings Google’s data-types table declares for HeightRecord. Google’s page: “Before requesting any permissions, your app must declare them in the manifest.”

AccessPermission stringFramework reference
Readandroid.permission.health.READ_HEIGHTAPI 34 · U Ext 7
Writeandroid.permission.health.WRITE_HEIGHTAPI 34 · U Ext 7
AndroidManifest.xml
<uses-permission android:name="android.permission.health.READ_HEIGHT" />
<uses-permission android:name="android.permission.health.WRITE_HEIGHT" />
Kotlin — the same strings from the Jetpack helper
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.HeightRecord

val permissions = setOf(
    HealthPermission.getReadPermission(HeightRecord::class),
    HealthPermission.getWritePermission(HeightRecord::class),
)

The 4 fields of HeightRecord

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.

FieldTypeAllowed rangeGoogle’s description
heightmandatoryLengthValid range: 0-3 meters.Height in Length unit. Required field. Valid range: 0-3 meters.
metadatamandatoryMetadata—Set of common metadata associated with the written record.
timemandatoryInstant—Time the record happened.
zoneOffsetZoneOffset?—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 HeightRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.

MetricValue typeGoogle’s description
HeightRecord.HEIGHT_AVGLengthMetric identifier to retrieve the average height from androidx.health.connect.client.aggregate.AggregationResult.
HeightRecord.HEIGHT_MAXLengthMetric identifier to retrieve the maximum height from androidx.health.connect.client.aggregate.AggregationResult.
HeightRecord.HEIGHT_MINLengthMetric identifier to retrieve minimum height from androidx.health.connect.client.aggregate.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 HeightRecord in Kotlin

The shape of Google’s own read example, with HeightRecord and its names filled in. Get the client with HealthConnectClient.getOrCreate(context) after checking getSdkStatus.

readRecords
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.HeightRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

suspend fun readHeight(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<HeightRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            HeightRecord::class,
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // One page of up to pageSize records (default 1000); follow
    // response.pageToken for the rest.
    return response.records
}
aggregate
import androidx.health.connect.client.HealthConnectClient
import androidx.health.connect.client.records.HeightRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
import androidx.health.connect.client.units.Length

suspend fun aggregateHeight(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): Length? {
    val response = client.aggregate(
        AggregateRequest(
            metrics = setOf(HeightRecord.HEIGHT_AVG),
            timeRangeFilter = TimeRangeFilter.between(startTime, endTime),
        )
    )
    // get() is declared as returning a nullable value.
    return response[HeightRecord.HEIGHT_AVG]
}

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 HeightRecord 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

This guide lists HeightRecord 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 HeightRecord need?
Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_HEIGHT for reading HeightRecord and android.permission.health.WRITE_HEIGHT for writing it, and says apps must declare permissions in the manifest before requesting them.
Which aggregate metrics does HeightRecord support?
Google's Jetpack reference defines 3 on HeightRecord: HEIGHT_AVG (AggregateMetric<Length>), HEIGHT_MAX (AggregateMetric<Length>) and HEIGHT_MIN (AggregateMetric<Length>). Pass them in the metrics set of an AggregateRequest and read each back from the AggregationResult.
What values does HeightRecord.height accept?
Google's reference types height as Length. Its description reads: "Height in Length unit. Required field. Valid range: 0-3 meters."
Is HeightRecord an interval, instantaneous or series record?
Google's data-types table lists HeightRecord 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 height, metadata and time.

Other Body Measurement records

All Body Measurement records →

Sources checked

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.

← All Health Connect records · Every permission string