daily.data.sleep_cycle.created

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
Wheelchair Push
Stand Hour
Stand Duration
Fall

Vitals Timeseries

Blood Pressure
Blood Oxygen
Cholesterol
Electrocardiogram Voltage
Glucose
IGE
IGG
Insulin Injection
Heart rate
HRV
Respiratory Rate
Forced Expiratory Volume 1
Forced Vital Capacity
Peak Expiratory Flow Rate
Inhaler Usage

Body Timeseries

Body Fat
Body Weight
Body Mass Index
Lean Body Mass
Waist Circumference
Body Temperature
Body Temperature Delta
Basal Body Temperature

Diary Timeseries

Note

Nutrition Timeseries

Caffeine
Carbohydrates
Water

Wellness Timeseries

Sleep Apnea Alert
Sleep Breathing Disturbance
Mindfulness Minutes
Stress Level
UV Exposure
Daylight Exposure
Handwashing

event_type

enum<string>

required

Available options:

daily.data.sleep_cycle.created,

daily.data.sleep_cycle.updated

user_id

string

required

client_user_id

string

required

team_id

string

required

data

object

required

data.id

string

required

data.sleep_id

string

required

data.session_start

string

required

data.session_end

string

required

data.stage_start_offset_second

integer[]

required

data.stage_end_offset_second

integer[]

required

data.stage_type

enum<integer>[]

required

Sleep stage classification: -1: Unknown or unclassified sleep stage; 1: Deep sleep; 2: Light/non-REM sleep; 3: Rapid Eye Movement sleep; 4: Awake period; 5: Manually classified stage.

ℹ️ This enum is non-exhaustive.

Available options:

-1,

1,

2,

3,

4,

5

Example:

[1, 3]

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

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

data.created_at

string

required

data.updated_at

string

required

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

string | null

data.source_app_id

string | null

Example:

{
  "created_at": "2023-02-27T20:31:24+00:00",
  "id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
  "session_end": "2022-01-01T08:00:00",
  "session_start": "2022-01-01T00:00:00",
  "sleep_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
  "source": { "provider": "oura", "type": "ring" },
  "source_provider": "oura",
  "source_type": "ring",
  "stage_end_offset_second": [300, 600, 900, 1200],
  "stage_start_offset_second": [0, 300, 600, 900],
  "stage_type": [1, 2, 3, 1],
  "time_zone": "America/Los_Angeles",
  "updated_at": "2023-02-28T01:22:38+00:00",
  "user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b"
}

historical.data.sleep.created daily.data.sleep_cycle.updated

{
  "event_type": "daily.data.sleep_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": {
    "created_at": "2023-02-27T20:31:24+00:00",
    "id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
    "session_end": "2022-01-01T08:00:00",
    "session_start": "2022-01-01T00:00:00",
    "sleep_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b",
    "source": {
      "provider": "oura",
      "type": "ring"
    },
    "source_provider": "oura",
    "source_type": "ring",
    "stage_end_offset_second": [
      300,
      600,
      900,
      1200
    ],
    "stage_start_offset_second": [
      0,
      300,
      600,
      900
    ],
    "stage_type": [
      1,
      2,
      3,
      1
    ],
    "time_zone": "America/Los_Angeles",
    "updated_at": "2023-02-28T01:22:38+00:00",
    "user_id": "f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b"
  }
}