Skip to content
AF
Health Connect reference

StepsCadenceRecord: Health Connect steps data

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

StepsCadenceRecord is Health Connect's steps record — a Series record in Google's Activity category. Its read permission is android.permission.health.READ_STEPS; its write permission is android.permission.health.WRITE_STEPS. It supports 3 aggregate metrics (RATE_AVG, RATE_MAX and RATE_MIN). Mandatory fields per Google's table: endTime, samples, metadata and startTime.

What Google says StepsCadenceRecord is

Captures the user's steps cadence. Each record represents a series of measurements.

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

Class
androidx.health.connect.client.records.StepsCadenceRecord
Google's category
Activity
Record type
Series
Unit class
none named in Google's table
Mandatory fields
endTimesamplesmetadatastartTime
Added in (Jetpack)
1.1.0
Same table row as
StepsRecord

Permissions

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

AccessPermission stringFramework reference
Readandroid.permission.health.READ_STEPSAPI 34 · U Ext 7
Writeandroid.permission.health.WRITE_STEPSAPI 34 · U Ext 7
  • READ_STEPS and WRITE_STEPS are also declared for StepsRecord in Google’s table.
AndroidManifest.xml
<uses-permission android:name="android.permission.health.READ_STEPS" />
<uses-permission android:name="android.permission.health.WRITE_STEPS" />
Kotlin — the same strings from the Jetpack helper
import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.StepsCadenceRecord

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

The 6 fields of StepsCadenceRecord

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
endTimemandatoryInstant—End time of the record.
endZoneOffsetZoneOffset?—User experienced zone offset at endTime, 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.
metadatamandatoryMetadata—Set of common metadata associated with the written record.
samplesmandatoryList<StepsCadenceRecord.Sample>—Google gives no description.
startTimemandatoryInstant—Start time of the record.
startZoneOffsetZoneOffset?—User experienced zone offset at startTime, 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.

Nested types

  • StepsCadenceRecord.Sample — Represents a single measurement of the steps cadence.

Aggregate metrics

The AggregateMetric constants Google defines on StepsCadenceRecord. The value type is the T in Google’s AggregateMetric<T> signature. Every aggregate metric across all records.

MetricValue typeGoogle’s description
StepsCadenceRecord.RATE_AVGDoubleMetric identifier to retrieve average steps cadence from androidx.health.connect.client.aggregate.AggregationResult.
StepsCadenceRecord.RATE_MAXDoubleMetric identifier to retrieve maximum steps cadence from androidx.health.connect.client.aggregate.AggregationResult.
StepsCadenceRecord.RATE_MINDoubleMetric identifier to retrieve minimum steps cadence 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 StepsCadenceRecord in Kotlin

The shape of Google’s own read example, with StepsCadenceRecord 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.StepsCadenceRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

suspend fun readStepsCadence(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<StepsCadenceRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            StepsCadenceRecord::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.StepsCadenceRecord
import androidx.health.connect.client.request.AggregateRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant

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

Setting up the client, the permission flow and Play Console declaration: integrating Health Connect step by step.

HealthKit counterpart

StepsCadenceRecord sits in the verified cross-platform matrix’s Steps row, which groups HKQuantityTypeIdentifier.stepCount (CMPedometer for live counts) on Apple with StepsRecord, StepsCadenceRecord 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: stepCount.

Watch out: De-duplicate: phone and watch both write steps. On Android, from the June 2026 update on-device steps are attributed to a per-device Synthetic Package Name — read it via getCurrentDeviceDataSource(), never hardcode it.

The metric on other platforms

This guide lists StepsCadenceRecord 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 StepsCadenceRecord need?
Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_STEPS for reading StepsCadenceRecord and android.permission.health.WRITE_STEPS for writing it, and says apps must declare permissions in the manifest before requesting them. READ_STEPS and WRITE_STEPS are also declared for StepsRecord.
Which aggregate metrics does StepsCadenceRecord support?
Google's Jetpack reference defines 3 on StepsCadenceRecord: RATE_AVG (AggregateMetric<Double>), RATE_MAX (AggregateMetric<Double>) and RATE_MIN (AggregateMetric<Double>). Pass them in the metrics set of an AggregateRequest and read each back from the AggregationResult.
Is StepsCadenceRecord an interval, instantaneous or series record?
Google's data-types table lists StepsCadenceRecord as Series, and defines that column as indicating "whether the data is recorded at an instant in time or over an interval". Its mandatory fields are endTime, samples, metadata and startTime.

Other Activity records

All Activity 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