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-19T09:19:50.199497+00:00",
"unit": "bpm",
"value": 104
},
{
"id": 1,
"timestamp": "2026-08-19T09:20:20.199506+00:00",
"unit": "bpm",
"value": 170
},
{
"id": 2,
"timestamp": "2026-08-19T09:20:50.199514+00:00",
"unit": "bpm",
"value": 148
},
{
"id": 3,
"timestamp": "2026-08-19T09:21:20.199522+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 4,
"timestamp": "2026-08-19T09:21:50.199530+00:00",
"unit": "bpm",
"value": 64
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-19T09:19:50.199367+00:00",
"unit": "rmssd",
"value": 85
},
{
"id": 1,
"timestamp": "2026-08-19T09:20:20.199437+00:00",
"unit": "rmssd",
"value": 62
},
{
"id": 2,
"timestamp": "2026-08-19T09:20:50.199459+00:00",
"unit": "rmssd",
"value": 48
},
{
"id": 3,
"timestamp": "2026-08-19T09:21:20.199475+00:00",
"unit": "rmssd",
"value": 59
},
{
"id": 4,
"timestamp": "2026-08-19T09:21:50.199486+00:00",
"unit": "rmssd",
"value": 70
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-19T09:19:50.199538+00:00",
"unit": "stage",
"value": 0
},
{
"id": 1,
"timestamp": "2026-08-19T09:20:20.199546+00:00",
"unit": "stage",
"value": 1
},
{
"id": 2,
"timestamp": "2026-08-19T09:20:50.199554+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-08-19T09:21:20.199561+00:00",
"unit": "stage",
"value": 1
},
{
"id": 4,
"timestamp": "2026-08-19T09:21:50.199568+00:00",
"unit": "stage",
"value": 2
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-19T09:19:50.199575+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 1,
"timestamp": "2026-08-19T09:20:20.199583+00:00",
"unit": "bpm",
"value": 15
},
{
"id": 2,
"timestamp": "2026-08-19T09:20:50.199593+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 3,
"timestamp": "2026-08-19T09:21:20.199600+00:00",
"unit": "bpm",
"value": 29
},
{
"id": 4,
"timestamp": "2026-08-19T09:21:50.199607+00:00",
"unit": "bpm",
"value": 19
}
]
}