Each summary is uniquely identified by its ID ($.id).

Given the same ID, the latest version of a summary you received replaces all its previous versions.

​
Properties

​
event_type
const string
required

Constant: daily.data.menstrual_cycle.updated

​
team_id
string
required
​
user_id
string
required
​
client_user_id
string
required
​
data
ClientFacingMenstrualCycle
required
​
id
string
required
​
period_start
string
required
​
period_end
anyOf
required

Any of:

  • string
  • null
​
cycle_end
anyOf
required

Any of:

  • string
  • null
​
is_predicted
boolean | null
​
menstrual_flow
MenstrualFlowEntry[] | null
​
date
string
required
​
flow
string
required
​
cervical_mucus
CervicalMucusEntry[] | null
​
date
string
required
​
quality
string
required
​
intermenstrual_bleeding
IntermenstrualBleedingEntry[] | null
​
date
string
required
​
contraceptive
ContraceptiveEntry[] | null
​
date
string
required
​
type
string
required
​
detected_deviations
DetectedDeviationEntry[] | null
​
date
string
required
​
deviation
string
required
​
ovulation_test
OvulationTestEntry[] | null
​
date
string
required
​
test_result
string
required
​
home_pregnancy_test
HomePregnancyTestEntry[] | null
​
date
string
required
​
test_result
string
required
​
home_progesterone_test
HomeProgesteroneTestEntry[] | null
​
date
string
required
​
test_result
string
required
​
sexual_activity
SexualActivityEntry[] | null
​
date
string
required
​
protection_used
anyOf
required

Any of:

  • boolean
  • null
​
basal_body_temperature
BasalBodyTemperatureEntry[] | null
​
date
string
required
​
value
number
required
​
source_provider
anyOf
required

Any of:

  • Providers
  • Labs
​
source_type
string
required
​
source_app_id
anyOf | null

Any of:

  • string
  • null
​
user_id
string
required
​
source
ClientFacingSource
required
​
provider
string
required

Provider slug. e.g., oura, fitbit, garmin.

​
type
string | null

The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown when Vital cannot extract or infer that information

​
app_id
anyOf | null

The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect. Any of:

  • string
  • null
​
name
string | null
deprecated

Deprecated. Subject to removal after 1 Jan 2024.

​
slug
string | null
deprecated

Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.

Deprecated. Subject to removal after 1 Jan 2024.

daily.data.menstrual_cycle.createdhistorical.data.menstrual_cycle.created