Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
Activity Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Summary
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": [],
"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",
"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
oura, fitbit, garmin, whoop, strava, renpho, peloton, wahoo, zwift, freestyle_libre, abbott_libreview, freestyle_libre_ble, eight_sleep, withings, apple_health_kit, manual, ihealth, google_fit, beurer_api, beurer_ble, omron, omron_ble, onetouch_ble, accuchek_ble, contour_ble, dexcom, dexcom_v3, hammerhead, my_fitness_pal, health_connect, polar, cronometer, kardia, whoop_v2, ultrahuman, my_fitness_pal_v2, map_my_fitness unknown, phone, watch, app, multiple_sources, fingerprick, cuff, manual_scan, automatic, scale, chest_strap, ring, lab Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.
Provider slug. e.g., oura, fitbit, garmin.
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
The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect.
For workout stream timeseries, this is the standard sport slug of the workout with which the timeseries data are associated.
For the distance timeseries, this is wheelchair_pushing if the user is a wheelchair user, or null otherwise.
For all summary types and non-workout timeseries, this is always null.
For workout stream timeseries, this is the workout ID with which the timeseries data are associated.
For all other types, this is always null.
Deprecated. Subject to removal after 1 Jan 2024.
Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.
Deprecated. Subject to removal after 1 Jan 2024.
{ "provider": "oura", "type": "ring" }
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": [],
"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",
"user_id": "cbd8b986-4225-4d36-8e2c-046ff2702769"
}
]
}