Summary

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 average heart rate variability registered during the sleep period.::rmssd

Average respiratory rate.::breaths per minute

Sleep stream data

Value

Timestamp

Id

Type

Unit

Value

Timestamp

Id

Type

Unit

Value

Timestamp

Id

Type

Unit

Value

Timestamp

Id

Type

Unit