Sleep
Sleep Cycle
Meal
Workouts
Profile
Activity
Body
Menstrual Cycle
Electrocardiogram
Vitals Timeseries
Activity Timeseries
Wellness Timeseries
Diary Timeseries
Nutrition Timeseries
Summary
Get sleep summary for user_id
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"sleep": [
{
"average_hrv": 78,
"awake": 2400,
"bedtime_start": "2023-02-27T12:31:24+00:00",
"bedtime_stop": "2023-02-27T12:31:24+00:00",
"calendar_date": "2023-02-27",
"date": "2023-02-27T12:31:24+00:00",
"deep": 2400,
"duration": 28800,
"efficiency": 0.97,
"hr_average": 50,
"hr_lowest": 43,
"id": "e2e0eb04-6641-4858-9de5-649efb41b346",
"latency": 1000,
"light": 2400,
"rem": 2400,
"respiratory_rate": 14,
"skin_temperature": 36.5,
"source": {
"provider": "oura",
"type": "unknown"
},
"temperature_delta": -0.2,
"timezone_offset": 2400,
"total": 28800,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
Authorizations
Vital Team API Key
Path Parameters
Query Parameters
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
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.
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
long_sleep: >=3 hours of sleep;
short_sleep: <3 hours of sleep;
acknowledged_nap: User-acknowledged naps, typically under 3 hours of sleep;
unknown: The sleep session recording is ongoing.
long_sleep, short_sleep, acknowledged_nap, unknown 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
Source the data has come from.
Provider slug. e.g., oura, fitbit, garmin.
The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to unknown when Vital cannot extract or infer that information
The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect.
Deprecated. Subject to removal after 1 Jan 2024.
Deprecated. Use provider instead. Subject to removal after 1 Jan 2024.
Deprecated. Subject to removal after 1 Jan 2024.
Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::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
Sleeping Heart Rate Dip is the percentage difference between your average waking heart rate and your average sleeping heart rate. In health studies, a greater "dip" is typically seen as a positive indicator of overall health. Currently only available for Garmin::perc
Some providers can provide updates to the sleep summary hours after the sleep period has ended. This field indicates the state of the sleep summary. For example, TENTATIVE means the summary is an intial prediction from the provider and can be subject to change. Currently only available for Garmin and EightSleep::str
tentative, confirmed The average heart rate variability registered during the sleep period::rmssd
Average respiratory rate::breaths per minute
Measured in rmssd.
The timestamp of the measurement.
HRV calculated using rmssd during sleep
Deprecated
Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection.
Measured in bpm.
The timestamp of the measurement.
Heart rate in bpm
Deprecated
Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection.
enum: 1: deep, 2: light, 3: rem, 4: awake, -1: missing_data.
Depracated. The start time (inclusive) of the interval.
The start time (inclusive) of the interval.
The end time (exclusive) of the interval.
Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "manual": 5, "missing_data": -1}
Deprecated
Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection.
Measured in bpm.
The timestamp of the measurement.
Average respiratory rate::breaths per minute
Deprecated
Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
The reading type of the measurement. This is applicable only to Cholesterol, IGG, IGE and InsulinInjection.
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{user_id}?start_date={{START_DATE}}&end_date={{END_DATE}} \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"sleep": [
{
"average_hrv": 78,
"awake": 2400,
"bedtime_start": "2023-02-27T12:31:24+00:00",
"bedtime_stop": "2023-02-27T12:31:24+00:00",
"calendar_date": "2023-02-27",
"date": "2023-02-27T12:31:24+00:00",
"deep": 2400,
"duration": 28800,
"efficiency": 0.97,
"hr_average": 50,
"hr_lowest": 43,
"id": "e2e0eb04-6641-4858-9de5-649efb41b346",
"latency": 1000,
"light": 2400,
"rem": 2400,
"respiratory_rate": 14,
"skin_temperature": 36.5,
"source": {
"provider": "oura",
"type": "unknown"
},
"temperature_delta": -0.2,
"timezone_offset": 2400,
"total": 28800,
"user_id": "1449752e-0d8a-40e0-9206-91ab099b2537"
}
]
}