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": [],
      "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",
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "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"
    }
  ]
}

GET

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",
        "device_id": "550e8400-e29b-41d4-a716-446655440000",
        "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

x-vital-api-key

string

header

required

Vital Team API Key

Path Parameters

user_id

string<uuid>

required

Query Parameters

provider

string

default:""

Provider oura/strava etc Provider oura/strava etc

start_date

string<date>

required

Start date in YYYY-MM-DD

end_date

string<date> | null

End date (inclusive) in YYYY-MM-DD

Response

Successful Response

menstrual_cycle

MenstrualCycle · object[]

required

Show child attributes

menstrual_cycle.id

string<uuid>

required

menstrual_cycle.period_start

string<date>

required

menstrual_cycle.source_provider

required

ℹ️ This enum is non-exhaustive.

Available options:

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,

runkeeper

menstrual_cycle.source_type

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

unknown,

phone,

watch,

app,

multiple_sources,

fingerprick,

cuff,

manual_scan,

automatic,

scale,

chest_strap,

ring,

lab,

exercise_machine,

earphone

menstrual_cycle.created_at

string<date-time>

required

menstrual_cycle.updated_at

string<date-time>

required

menstrual_cycle.user_id

string<uuid>

required

menstrual_cycle.source

Source · object

required

Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.

Show child attributes

menstrual_cycle.source.provider

string

required

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

menstrual_cycle.source.type

string

default:unknown

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

menstrual_cycle.source.app_id

string | 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.

menstrual_cycle.source.device_id

string<uuid> | null

The identifier of the device which recorded this summary.

menstrual_cycle.source.sport

string | null

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.

menstrual_cycle.source.workout_id

string<uuid> | 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.

menstrual_cycle.source.name

string

default:""

deprecated

Deprecated. Subject to removal after 1 Jan 2024.

menstrual_cycle.source.slug

string

default:""

deprecated

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

menstrual_cycle.source.logo

string

default:""

deprecated

Deprecated. Subject to removal after 1 Jan 2024.

Example:

{ "provider": "oura", "type": "ring" }

menstrual_cycle.period_end

string<date> | null

menstrual_cycle.cycle_end

string<date> | null

menstrual_cycle.is_predicted

boolean

default:false

menstrual_cycle.menstrual_flow

MenstrualFlowEntry · object[]

Show child attributes

menstrual_cycle.menstrual_flow.date

string<date>

required

menstrual_cycle.menstrual_flow.flow

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

unspecified,

none,

light,

medium,

heavy

menstrual_cycle.cervical_mucus

CervicalMucusEntry · object[]

Show child attributes

menstrual_cycle.cervical_mucus.date

string<date>

required

menstrual_cycle.cervical_mucus.quality

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

dry,

sticky,

creamy,

watery,

egg_white

menstrual_cycle.intermenstrual_bleeding

IntermenstrualBleedingEntry · object[]

Show child attributes

menstrual_cycle.intermenstrual_bleeding.date

string<date>

required

menstrual_cycle.contraceptive

ContraceptiveEntry · object[]

Show child attributes

menstrual_cycle.contraceptive.date

string<date>

required

menstrual_cycle.contraceptive.type

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

unspecified,

implant,

injection,

iud,

intravaginal_ring,

oral,

patch

menstrual_cycle.detected_deviations

DetectedDeviationEntry · object[]

Show child attributes

menstrual_cycle.detected_deviations.date

string<date>

required

menstrual_cycle.detected_deviations.deviation

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

persistent_intermenstrual_bleeding,

prolonged_menstrual_periods,

irregular_menstrual_cycles,

infrequent_menstrual_cycles

menstrual_cycle.ovulation_test

OvulationTestEntry · object[]

Show child attributes

menstrual_cycle.ovulation_test.date

string<date>

required

menstrual_cycle.ovulation_test.test_result

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

negative,

positive,

luteinizing_hormone_surge,

estrogen_surge,

indeterminate

menstrual_cycle.home_pregnancy_test

HomePregnancyTestEntry · object[]

Show child attributes

menstrual_cycle.home_pregnancy_test.date

string<date>

required

menstrual_cycle.home_pregnancy_test.test_result

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

negative,

positive,

indeterminate

menstrual_cycle.home_progesterone_test

HomeProgesteroneTestEntry · object[]

Show child attributes

menstrual_cycle.home_progesterone_test.date

string<date>

required

menstrual_cycle.home_progesterone_test.test_result

enum<string>

required

ℹ️ This enum is non-exhaustive.

Available options:

negative,

positive,

indeterminate

menstrual_cycle.sexual_activity

SexualActivityEntry · object[]

Show child attributes

menstrual_cycle.sexual_activity.date

string<date>

required

menstrual_cycle.sexual_activity.protection_used

boolean | null

menstrual_cycle.basal_body_temperature

BasalBodyTemperatureEntry · object[]

Show child attributes

menstrual_cycle.basal_body_temperature.date

string<date>

required

menstrual_cycle.basal_body_temperature.value

number

required

menstrual_cycle.source_app_id

string | null

menstrual_cycle.source_device_id

string<uuid> | null

Raw Summary

⌘I

Debugging

Device

Sleep

Sleep Cycle

Meal

Workouts

Profile

Activity

Body

Menstrual Cycle

Electrocardiogram

Vitals Timeseries

Body Timeseries

Activity Timeseries

Workout Stream Timeseries

Wellness Timeseries

Diary Timeseries

Nutrition Timeseries

Authorizations

Path Parameters

Query Parameters

Response