Get User Sleep

Provider oura/strava etc.

200

Successful Response

Response body

object

sleep

array of objects

required

Sleep*

object

user_id

uuid

required

User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api.

user_key

uuid

required

date

date-time

required

Date for specified record

bedtime_start

date-time

required

UTC Time when the sleep period started

bedtime_stop

date-time

required

UTC Time when the sleep period ended

timezone_offset

integer

Timezone offset from UTC as minutes. For example, EEST (Eastern European Summer Time, +3h) is 180. PST (Pacific Standard Time, -8h) is -480

duration

integer

required

Total duration of the sleep period (sleep.duration = sleep.bedtime_end - sleep.bedtime_start).::seconds

total

integer

required

Total amount of sleep registered during the sleep period (sleep.total = sleep.rem + sleep.light + sleep.deep).::seconds

awake

integer

required

Total amount of awake time registered during the sleep period.::seconds

light

integer

required

Total amount of light sleep registered during the sleep period::seconds

rem

integer

required

Total amount of REM sleep registered during the sleep period, minutes::seconds

deep

integer

required

Total amount of deep (N3) sleep registered during the sleep period::seconds

hr_lowest

integer

The lowest heart rate (5 minutes sliding average) registered during the sleep period.::beats per minute

hr_average

integer

The average heart rate registered during the sleep period.::beats per minute

efficiency

number

Sleep efficiency is the percentage of the sleep period spent asleep (100% * sleep.total / sleep.duration).::perc

latency

integer

Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep.::seconds

temperature_delta

number

Skin temperature deviation from the long-term temperature average.::celcius

average_hrv

number

The average heart rate registered during the sleep period.::beats per minute

respiratory_rate

number

Average respiratory rate.::breaths per minute

source

object

required

Source the data has come from.

sleep_stream

object

Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "missing_data": -1}

200Successful Response

422Validation Error