timeseries
Get User Sleep Stream
Get Sleep stream for a user_id
get/v2/timeseries/sleep/{sleep_id}/stream
Path parameters
sleep_idstring uuid required
The Vital Sleep ID
The Vital Sleep ID
Response
Successful Response
Example response
{
"heartrate": [
{
"id": 0,
"timestamp": "2026-08-02T13:11:45.387121+00:00",
"unit": "bpm",
"value": 95
},
{
"id": 1,
"timestamp": "2026-08-02T13:12:15.387130+00:00",
"unit": "bpm",
"value": 91
},
{
"id": 2,
"timestamp": "2026-08-02T13:12:45.387138+00:00",
"unit": "bpm",
"value": 91
},
{
"id": 3,
"timestamp": "2026-08-02T13:13:15.387147+00:00",
"unit": "bpm",
"value": 89
},
{
"id": 4,
"timestamp": "2026-08-02T13:13:45.387154+00:00",
"unit": "bpm",
"value": 12
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-02T13:11:45.386994+00:00",
"unit": "rmssd",
"value": 7
},
{
"id": 1,
"timestamp": "2026-08-02T13:12:15.387063+00:00",
"unit": "rmssd",
"value": 68
},
{
"id": 2,
"timestamp": "2026-08-02T13:12:45.387085+00:00",
"unit": "rmssd",
"value": 50
},
{
"id": 3,
"timestamp": "2026-08-02T13:13:15.387100+00:00",
"unit": "rmssd",
"value": 98
},
{
"id": 4,
"timestamp": "2026-08-02T13:13:45.387111+00:00",
"unit": "rmssd",
"value": 83
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-02T13:11:45.387161+00:00",
"unit": "stage",
"value": 1
},
{
"id": 1,
"timestamp": "2026-08-02T13:12:15.387168+00:00",
"unit": "stage",
"value": 0
},
{
"id": 2,
"timestamp": "2026-08-02T13:12:45.387176+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-08-02T13:13:15.387189+00:00",
"unit": "stage",
"value": 4
},
{
"id": 4,
"timestamp": "2026-08-02T13:13:45.387195+00:00",
"unit": "stage",
"value": 4
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-02T13:11:45.387202+00:00",
"unit": "bpm",
"value": 21
},
{
"id": 1,
"timestamp": "2026-08-02T13:12:15.387209+00:00",
"unit": "bpm",
"value": 22
},
{
"id": 2,
"timestamp": "2026-08-02T13:12:45.387215+00:00",
"unit": "bpm",
"value": 12
},
{
"id": 3,
"timestamp": "2026-08-02T13:13:15.387222+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 4,
"timestamp": "2026-08-02T13:13:45.387229+00:00",
"unit": "bpm",
"value": 28
}
]
}