CervicalMucusRecord: Health Connect cervical mucus data

What Google says CervicalMucusRecord is

Captures the description of cervical mucus. Each record represents a self-assessed description of cervical mucus for a user. All fields are optional and can be used to describe the look and feel of cervical mucus.

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

Class

androidx.health.connect.client.records.CervicalMucusRecord

Google's category

Cycle Tracking

Record type

Instantaneous

Unit class

none named in Google's table

Mandatory fields

appearancesensationmetadatatime

Added in (Jetpack)

1.1.0

Permissions

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

<uses-permission android:name="android.permission.health.READ_CERVICAL_MUCUS" />
<uses-permission android:name="android.permission.health.WRITE_CERVICAL_MUCUS" />

import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.CervicalMucusRecord

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

The 5 fields of CervicalMucusRecord

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.

Constants

The 11 const val values Google’s reference lists on CervicalMucusRecord, with the integer each maps to.

Read CervicalMucusRecord in Kotlin

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

suspend fun readCervicalMucus(
    client: HealthConnectClient,
    startTime: Instant,
    endTime: Instant,
): List<CervicalMucusRecord> {
    val response = client.readRecords(
        ReadRecordsRequest(
            CervicalMucusRecord::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 CervicalMucusRecord 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 CervicalMucusRecord 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.

• Menstrual Cycle API: How to Get Cycle Tracking Data

Questions

What permission does CervicalMucusRecord need?

Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_CERVICAL_MUCUS for reading CervicalMucusRecord and android.permission.health.WRITE_CERVICAL_MUCUS for writing it, and says apps must declare permissions in the manifest before requesting them.

Can you aggregate CervicalMucusRecord with AggregateRequest?

Not directly. As read on 2026-10-03, Google's Jetpack reference defines no AggregateMetric constants on CervicalMucusRecord, so there is no metric to put in an AggregateRequest. Read the records with readRecords and a ReadRecordsRequest, and compute any summary yourself.

Which constants does CervicalMucusRecord define?

Google's reference lists 11 constants on CervicalMucusRecord, including APPEARANCE_CREAMY = 3, APPEARANCE_DRY = 1, APPEARANCE_EGG_WHITE = 5, APPEARANCE_STICKY = 2, APPEARANCE_UNKNOWN = 0, APPEARANCE_UNUSUAL = 6, APPEARANCE_WATERY = 4 and SENSATION_HEAVY = 3 and more. Store the constant name or the value it maps to, and treat values you do not recognise as unknown.

Is CervicalMucusRecord an interval, instantaneous or series record?

Google's data-types table lists CervicalMucusRecord 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 appearance, sensation, metadata and time.