Menstrual Cycle
Summary
Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
- GETAfib Burden
- GETBlood Oxygen
- GETBlood Pressure
- GETCholesterol
- GETGlucose
- GETHeart Rate
- GETHeart Rate Variability
- GETHeart Rate Alert
- GETInsulin Injection
- GETIgg
- GETIge
- GETRespiratory Rate
- GETVo2 Max
- GETForced Expiratory Volume 1
- GETForced Vital Capacity
- GETPeak Expiratory Flow Rate
- GETInhaler Usage
- GETHeart Rate Recovery One Minute
Body Timeseries
Activity Timeseries
Workout Stream Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Menstrual Cycle
Summary
GET
/
v2
/
summary
/
menstrual_cycle
/
{user_id}
curl --request GET \
--url {{BASE_URL}}/v2/summary/menstrual_cycle/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"menstrual_cycle": [
{
"basal_body_temperature": [],
"cervical_mucus": [],
"contraceptive": [],
"created_at": "2023-02-27T20:31:24+00:00",
"cycle_end": "2024-05-01",
"detected_deviations": [],
"home_pregnancy_test": [],
"home_progesterone_test": [],
"id": "e1274c3e-c035-4bd7-86aa-2eb15d6d0137",
"intermenstrual_bleeding": [
{
"date": "2024-04-17"
}
],
"is_predicted": false,
"menstrual_flow": [
{
"date": "2024-04-07",
"flow": "light"
},
{
"date": "2024-04-10",
"flow": "medium"
},
{
"date": "2024-04-11",
"flow": "heavy"
}
],
"ovulation_test": [],
"period_end": "2024-04-11",
"period_start": "2024-04-07",
"sexual_activity": [
{
"date": "2024-04-13",
"protection_used": true
}
],
"source": {
"app_id": "com.apple.Health",
"provider": "apple_health_kit",
"type": "app"
},
"source_app_id": "com.apple.Health",
"source_provider": "apple_health_kit",
"source_type": "app",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "cbd8b986-4225-4d36-8e2c-046ff2702769"
}
]
}
curl --request GET \
--url {{BASE_URL}}/v2/summary/menstrual_cycle/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
Provider oura/strava etc
Start date in YYYY-MM-DD
End date (inclusive) in YYYY-MM-DD
Response
200
application/json
Successful Response
The response is of type object
.
curl --request GET \
--url {{BASE_URL}}/v2/summary/menstrual_cycle/{user_id} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"menstrual_cycle": [
{
"basal_body_temperature": [],
"cervical_mucus": [],
"contraceptive": [],
"created_at": "2023-02-27T20:31:24+00:00",
"cycle_end": "2024-05-01",
"detected_deviations": [],
"home_pregnancy_test": [],
"home_progesterone_test": [],
"id": "e1274c3e-c035-4bd7-86aa-2eb15d6d0137",
"intermenstrual_bleeding": [
{
"date": "2024-04-17"
}
],
"is_predicted": false,
"menstrual_flow": [
{
"date": "2024-04-07",
"flow": "light"
},
{
"date": "2024-04-10",
"flow": "medium"
},
{
"date": "2024-04-11",
"flow": "heavy"
}
],
"ovulation_test": [],
"period_end": "2024-04-11",
"period_start": "2024-04-07",
"sexual_activity": [
{
"date": "2024-04-13",
"protection_used": true
}
],
"source": {
"app_id": "com.apple.Health",
"provider": "apple_health_kit",
"type": "app"
},
"source_app_id": "com.apple.Health",
"source_provider": "apple_health_kit",
"source_type": "app",
"updated_at": "2023-02-28T01:22:38+00:00",
"user_id": "cbd8b986-4225-4d36-8e2c-046ff2702769"
}
]
}