daily.data.menstrual_cycle.updated

Lab Tests

Orders
Results
Appointments

Provider

Summaries

Activity
Body
Meal
Menstrual Cycle
Profile
Sleep
Sleep Cycle
Workout
Workout Stream

Activity Timeseries

Calories Active
Calories Basal
Distance
Floors Climbed
Steps
VO2 Max
Workout Duration

Vitals Timeseries

Blood Pressure
Blood Oxygen
Cholesterol
Electrocardiogram Voltage
Glucose
IGE
IGG
Insulin Injection
Heart rate
HRV
Respiratory Rate

Body Timeseries

Body Fat
Body Weight
Body Temperature
Body Temperature Delta

Diary Timeseries

Note

Nutrition Timeseries

Caffeine
Carbohydrates
Water

Wellness Timeseries

Mindfulness Minutes
Stress Level

event_type

enum<string>

required

Available options:

daily.data.menstrual_cycle.created,

daily.data.menstrual_cycle.updated

user_id

string

required

client_user_id

string

required

team_id

string

required

data

object

required

data.id

string

required

data.period_start

string

required

data.period_end

string | null

required

data.cycle_end

string | null

required

data.source_provider

required

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

data.source_type

enum<string>

required

Available options:

unknown,

phone,

watch,

app,

multiple_sources,

fingerprick,

cuff,

manual_scan,

automatic,

scale,

chest_strap,

ring,

lab

data.user_id

string

required

data.source

object

required

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

Example:

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

data.is_predicted

boolean

default:false

data.menstrual_flow

object[]

data.cervical_mucus

object[]

data.intermenstrual_bleeding

object[]

data.contraceptive

object[]

data.detected_deviations

object[]

data.ovulation_test

object[]

data.home_pregnancy_test

object[]

data.home_progesterone_test

object[]

data.sexual_activity

object[]

data.basal_body_temperature

object[]

data.source_app_id

string | null

Example:

{
  "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"
}

daily.data.menstrual_cycle.created historical.data.menstrual_cycle.created

{
  "event_type": "daily.data.menstrual_cycle.created",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "client_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "data": {
    "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"
  }
}