- Sleep
- Summary
Summary
/v2/summary/sleep/{user_id}
Parameters
User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api.
Provider oura/strava etc
Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59
Response
Source the data has come from.
Total amount of deep (N3) sleep registered during the sleep period::seconds
Total amount of REM sleep registered during the sleep period, minutes::seconds
Total amount of light sleep registered during the sleep period::seconds
Total amount of awake time registered during the sleep period::seconds
Total amount of sleep registered during the sleep period (sleep.total = sleep.rem + sleep.light + sleep.deep)::seconds
Total duration of the sleep period (sleep.duration = sleep.bedtime_end - sleep.bedtime_start)::seconds
UTC Time when the sleep period ended
UTC Time when the sleep period started
Date for specified record
Id
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 returned by vital create user key request. This key should be stored in your database against the user and used for all interactions with the vital api.
Timezone offset from UTC as minutes. For example, EEST (Eastern European Summer Time, +3h) is 180. PST (Pacific Standard Time, -8h) is -480
A value between 1 and 100 representing how well the user slept. Currently only available for Withings, Oura, Whoop and Garmin::scalar
The lowest heart rate (5 minutes sliding average) registered during the sleep period::beats per minute
The average heart rate registered during the sleep period::beats per minute
Sleep efficiency is the percentage of the sleep period spent asleep (100% * sleep.total / sleep.duration)::perc
Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep::seconds
Skin temperature deviation from the long-term temperature average::celcius
The skin temperature::celcius
The average heart rate variability registered during the sleep period::rmssd
Average respiratory rate::breaths per minute
Sleep stream data
Measured in rmssd.
HRV calculated using rmssd during sleep
The timestamp of the measurement.
Measurement id. Note, this field has been deprecated and is no longer used
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
Measured in bpm.
Heart rate in bpm
The timestamp of the measurement.
Measurement id. Note, this field has been deprecated and is no longer used
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
enum: 1: deep, 2: light, 3: rem, 4: awake, -1: missing_data.
Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "manual": 5, "missing_data": -1}
The timestamp of the measurement.
Measurement id. Note, this field has been deprecated and is no longer used
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
Measured in bpm.
Average respiratory rate::breaths per minute
The timestamp of the measurement.
Measurement id. Note, this field has been deprecated and is no longer used
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.