Vital home page
Search...
GitHub
Get Started
Theme
Search
Navigation
Navigation
Sleep
Stream
Documentation
Wearables
Lab Testing
API Reference
User
Create User
Get User
Delete User
Get Team Users
Get Connected Providers
Refresh User Data
Deregister a Provider
Providers
List of Providers
Link
Generate a link token
Link OAuth provider
Link Password provider
Link Email provider
Link Demo provider
Sleep
Summary
Stream
Raw
Workouts
Summary
Stream
Raw
Profile
Summary
Raw
Activity
Summary
Raw
Body
Summary
Raw
Vitals
Blood Oxygen
Blood Pressure
Cholesterol
Glucose
Heartrate
IGE
IGG
Orders
Create Order
Get Order
Cancel Order
Lab Tests
Get Available Tests
Results
Get Results
Get Results PDF
Get Results Metadata
Legacy
Get Testkits
Create Order
Cancel Order
Get Results
Get Results Raw
Get Results Metadata
Sleep
Edit this page
Raise an issue
Stream
Get Sleep stream for a user_id
GET
Select API base
https://api.tryvital.io
https://api.sandbox.tryvital.io
https://api.eu.tryvital.io
https://api.sandbox.eu.tryvital.io
/v2/timeseries/sleep/{sleep_id}/stream
Authorization
Path
x-vital-api-key
*
Send Request
Parameters
sleep_id
Required
string
Sleep Id
Response
hrv
array
Show object
value
Required
number
Value
timestamp
Required
string
Timestamp
id
integer
Id
type
string
Type
unit
string
Unit
heartrate
array
Show object
value
Required
number
Value
timestamp
Required
string
Timestamp
id
integer
Id
type
string
Type
unit
string
Unit
hypnogram
array
Show object
value
Required
number
Value
timestamp
Required
string
Timestamp
id
integer
Id
type
string
Type
unit
string
Unit
respiratory_rate
array
Show object
value
Required
number
Value
timestamp
Required
string
Timestamp
id
integer
Id
type
string
Type
unit
string
Unit
