Menstrual Period: the Google Health API menstrual-period data type

Menstrual Period at a glance

From the Menstrual Period row of Google’s data-types table, joined to the discovery document’s DataPoint schema.

Display name

Menstrual Period

dataType (in endpoint URLs)

menstrual-period

filter parameter

menstrual_periodGoogle: “The identifier separated by underscores (for example, active_minutes) used as the value for the dataType filter parameter in daily rollup and rollup requests.”

Record type

Interval — Google: “Represents measurements recorded over a duration.”

Storage resolution

not stated in Google’s table

Webhook support

Not marked in Google’s table

True zeros support

Not marked in Google’s table

Channel

v4

DataPoint field

DataPoint.menstrualPeriod → MenstrualPeriodIts description: “Optional. Data for points in the menstrual-period interval data type collection.”

Compatible devices

0 in Google’s table

Operations and request paths

The operations Google’s table lists for menstrual-period, each matched to its users.dataTypes.dataPoints method in the discovery document. The path is the documented path template (the method’s flatPath on https://health.googleapis.com/) with {dataTypesId} filled in as menstrual-period. Google on {user}: “The {user} can be either the alias me or the authenticated user's numeric Health User ID (retrieved via GetIdentity).”

Every method, and how many of the data types list it: the methods overview.

Scopes

The scopes Google’s table lists for menstrual-period, as full URLs, with the consent text Google’s Scopes page gives each. Every Google Health API scope.

Fields of Menstrual Period

The schema the discovery document gives DataPoint.menstrualPeriod, required fields first. Types are as the discovery document states them; the label is the word Google’s description opens with. The schemas its fields refer to follow, one level deep.

Fitbit Web API predecessor

Google’s Fitbit Web API → Google Health API data-type table has no row for menstrual-period, so it names no Fitbit Web API predecessor.

Google’s full Fitbit Web API mapping tables · the migration playbook

Where Google’s pages disagree

Published as found, with the texts that disagree; nothing here is corrected by us.

• Operation name differs

  The table lists "update" for menstrual-period, but the discovery document has no method named update; Google's endpoint-mapping table points updates at patch.

  • Google's Fitbit migration API specifications: “CREATE & UPDATE Logs”
  • Google's Fitbit migration API specifications: “patch method”
  • the v4 discovery document: “Updates a single identifiable data point. If a data point with the specified name is not found, the request will fail.”