MenstruationPeriodRecord: Health Connect menstruation data
Read from Google’s documentation on 2026-10-03 · Google’s reference page last updated 2026-06-24
MenstruationPeriodRecord is Health Connect's menstruation record — an Interval record in Google's Cycle Tracking category. Its read permission is android.permission.health.READ_MENSTRUATION; its write permission is android.permission.health.WRITE_MENSTRUATION. Google's reference defines no aggregate metrics on it, so it is read with readRecords rather than aggregate. Mandatory fields per Google's table: endTime, metadata and startTime.
What Google says MenstruationPeriodRecord is
Captures user's menstruation periods.
Quoted from Google’s MenstruationPeriodRecord Jetpack reference, last updated 2026-06-24, read 2026-10-03.
- Class
androidx.health.connect.client.records.MenstruationPeriodRecord- Google's category
- Cycle Tracking
- Record type
- Interval
- Unit class
- none named in Google's table
- Mandatory fields
endTimemetadatastartTime- Added in (Jetpack)
1.1.0- Same table row as
- MenstruationFlowRecord
Permissions
The exact strings Google’s data-types table declares for MenstruationPeriodRecord. 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_MENSTRUATION | API 34 · U Ext 7 |
| Write | android.permission.health.WRITE_MENSTRUATION | API 34 · U Ext 7 |
READ_MENSTRUATIONandWRITE_MENSTRUATIONare also declared for MenstruationFlowRecord in Google’s table.
<uses-permission android:name="android.permission.health.READ_MENSTRUATION" />
<uses-permission android:name="android.permission.health.WRITE_MENSTRUATION" />import androidx.health.connect.client.permission.HealthPermission
import androidx.health.connect.client.records.MenstruationPeriodRecord
val permissions = setOf(
HealthPermission.getReadPermission(MenstruationPeriodRecord::class),
HealthPermission.getWritePermission(MenstruationPeriodRecord::class),
)The 5 fields of MenstruationPeriodRecord
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 |
|---|---|---|---|
endTimemandatory | Instant | — | End time of the record. |
endZoneOffset | ZoneOffset? | — | 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. |
metadatamandatory | Metadata | — | Set of common metadata associated with the written record. |
startTimemandatory | Instant | — | Start time of the record. |
startZoneOffset | ZoneOffset? | — | 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. |
Read MenstruationPeriodRecord in Kotlin
The shape of Google’s own read example, with MenstruationPeriodRecord 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.MenstruationPeriodRecord
import androidx.health.connect.client.request.ReadRecordsRequest
import androidx.health.connect.client.time.TimeRangeFilter
import java.time.Instant
suspend fun readMenstruationPeriod(
client: HealthConnectClient,
startTime: Instant,
endTime: Instant,
): List<MenstruationPeriodRecord> {
val response = client.readRecords(
ReadRecordsRequest(
MenstruationPeriodRecord::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 MenstruationPeriodRecord 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 MenstruationPeriodRecord 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 MenstruationPeriodRecord need?
- Google's Health Connect data-types table (read 2026-10-03) declares android.permission.health.READ_MENSTRUATION for reading MenstruationPeriodRecord and android.permission.health.WRITE_MENSTRUATION for writing it, and says apps must declare permissions in the manifest before requesting them. READ_MENSTRUATION and WRITE_MENSTRUATION are also declared for MenstruationFlowRecord.
- Can you aggregate MenstruationPeriodRecord with AggregateRequest?
- Not directly. As read on 2026-10-03, Google's Jetpack reference defines no AggregateMetric constants on MenstruationPeriodRecord, so there is no metric to put in an AggregateRequest. Read the records with readRecords and a ReadRecordsRequest, and compute any summary yourself.
- Is MenstruationPeriodRecord an interval, instantaneous or series record?
- Google's data-types table lists MenstruationPeriodRecord as Interval, 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, metadata and startTime.
Other Cycle Tracking records
Sources checked
- Google — MenstruationPeriodRecord (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.