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-07T08:22:21.613667+00:00",
"unit": "bpm",
"value": 25
},
{
"id": 1,
"timestamp": "2026-08-07T08:22:51.613677+00:00",
"unit": "bpm",
"value": 116
},
{
"id": 2,
"timestamp": "2026-08-07T08:23:21.613686+00:00",
"unit": "bpm",
"value": 147
},
{
"id": 3,
"timestamp": "2026-08-07T08:23:51.613695+00:00",
"unit": "bpm",
"value": 4
},
{
"id": 4,
"timestamp": "2026-08-07T08:24:21.613703+00:00",
"unit": "bpm",
"value": 156
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-07T08:22:21.613525+00:00",
"unit": "rmssd",
"value": 23
},
{
"id": 1,
"timestamp": "2026-08-07T08:22:51.613606+00:00",
"unit": "rmssd",
"value": 6
},
{
"id": 2,
"timestamp": "2026-08-07T08:23:21.613628+00:00",
"unit": "rmssd",
"value": 82
},
{
"id": 3,
"timestamp": "2026-08-07T08:23:51.613645+00:00",
"unit": "rmssd",
"value": 89
},
{
"id": 4,
"timestamp": "2026-08-07T08:24:21.613656+00:00",
"unit": "rmssd",
"value": 97
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-07T08:22:21.613711+00:00",
"unit": "stage",
"value": 4
},
{
"id": 1,
"timestamp": "2026-08-07T08:22:51.613719+00:00",
"unit": "stage",
"value": 1
},
{
"id": 2,
"timestamp": "2026-08-07T08:23:21.613728+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-08-07T08:23:51.613739+00:00",
"unit": "stage",
"value": 1
},
{
"id": 4,
"timestamp": "2026-08-07T08:24:21.613747+00:00",
"unit": "stage",
"value": 3
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-07T08:22:21.613754+00:00",
"unit": "bpm",
"value": 29
},
{
"id": 1,
"timestamp": "2026-08-07T08:22:51.613761+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 2,
"timestamp": "2026-08-07T08:23:21.613769+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 3,
"timestamp": "2026-08-07T08:23:51.613778+00:00",
"unit": "bpm",
"value": 26
},
{
"id": 4,
"timestamp": "2026-08-07T08:24:21.613786+00:00",
"unit": "bpm",
"value": 20
}
]
}