- Home
- Wearables
- Lab Testing
- API Reference
- Event Catalog
- Changelog
- Users
- Debugging
- Orders
- Area Info
- At-home Phlebotomy
- Tests
- Results
- Health Insurance
- Vitals
- Body
- Activity
- Wellness
- Nutrition
- Team
- Member
- Invite
- Org
- Team API Keys
- Team Custom Credentials
- Team Data Pull Preferences
- Team ETL Pipeline
- Team Scope Requirements
Core
Lab Testing
Timeseries Data
Org Management
Stream
Get Sleep stream for a user_id
Vital Team API Key
The Vital Sleep ID
Authorizations
Vital Team API Key
Path Parameters
The Vital Sleep ID
Response
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 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