daily.data.sleep.updated
Each summary object is uniquely identified by its id.
If multiple events are received at the same id, the last event received replaces all its previous
versions.
Properties
Constant: daily.data.sleep.updated
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.
[⚠️ Deprecated] 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.
[⚠️ Deprecated] Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date.
Date of the sleep summary in the YYYY-mm-dd format. This generally matches the sleep end date.
UTC Time when the sleep period started
UTC Time when the sleep period ended
Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds
Total duration of the sleep period (sleep.duration = sleep.bedtime_end - sleep.bedtime_start)::seconds
Total amount of sleep registered during the sleep period (sleep.total = sleep.rem + sleep.light + sleep.deep)::seconds
Total amount of awake time registered during the sleep period::seconds
Total amount of light sleep registered during the sleep period::seconds
Total amount of REM sleep registered during the sleep period, minutes::seconds
Total amount of deep (N3) sleep registered during the sleep period::seconds
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
Source the data has come from.
Name of source of information
Slug for designated source
URL for source logo
Measurement id. Note, this field has been deprecated and is no longer used
The timestamp of the measurement.
Time zone UTC offset of the measurement. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
HRV calculated using rmssd during sleep
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
Measured in rmssd.
Measurement id. Note, this field has been deprecated and is no longer used
The timestamp of the measurement.
Time zone UTC offset of the measurement. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
Heart rate in bpm
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
Measured in bpm.
Measurement id. Note, this field has been deprecated and is no longer used
The timestamp of the measurement.
Time zone UTC offset of the measurement. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
Hypnogram for sleep stages {“deep”: 1, “light”: 2, “rem”: 3, “awake”: 4, “manual”: 5, “missing_data”: -1}
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.
Measurement id. Note, this field has been deprecated and is no longer used
The timestamp of the measurement.
Time zone UTC offset of the measurement. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
Average respiratory rate::breaths per minute
The reading type of the measurement, e.g. cuff, scale, manual_scan, etc.
Measured in bpm.
Examples
{
"event_type": "daily.data.sleep.updated",
"data": {
"id": "ba3b6572-2348-478d-91a0-9c7e07a7a38c",
"date": "2023-05-26T20:56:49.395792+00:00",
"calendar_date": "2023-05-26",
"bedtime_start": "2023-05-26T20:56:49.395808+00:00",
"bedtime_stop": "2023-05-26T20:56:49.395812+00:00",
"timezone_offset": 2400,
"duration": 28800,
"total": 28800,
"awake": 2400,
"light": 2400,
"rem": 2400,
"deep": 2400,
"hr_lowest": 43,
"hr_average": 50,
"efficiency": 0.97,
"latency": 1000,
"temperature_delta": -0.2,
"skin_temperature": 36.5,
"average_hrv": 78,
"respiratory_rate": 14,
"source": {
"name": "Oura",
"slug": "oura",
"logo": "https://logo_url.com"
},
"user_id": "b389d7e3-1968-408e-a678-bd18b63e7f7c"
}
}