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-18T07:33:39.568006+00:00",
"unit": "bpm",
"value": 65
},
{
"id": 1,
"timestamp": "2026-08-18T07:34:09.568018+00:00",
"unit": "bpm",
"value": 120
},
{
"id": 2,
"timestamp": "2026-08-18T07:34:39.568028+00:00",
"unit": "bpm",
"value": 47
},
{
"id": 3,
"timestamp": "2026-08-18T07:35:09.568037+00:00",
"unit": "bpm",
"value": 140
},
{
"id": 4,
"timestamp": "2026-08-18T07:35:39.568046+00:00",
"unit": "bpm",
"value": 170
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-18T07:33:39.567746+00:00",
"unit": "rmssd",
"value": 94
},
{
"id": 1,
"timestamp": "2026-08-18T07:34:09.567939+00:00",
"unit": "rmssd",
"value": 94
},
{
"id": 2,
"timestamp": "2026-08-18T07:34:39.567964+00:00",
"unit": "rmssd",
"value": 20
},
{
"id": 3,
"timestamp": "2026-08-18T07:35:09.567983+00:00",
"unit": "rmssd",
"value": 46
},
{
"id": 4,
"timestamp": "2026-08-18T07:35:39.567995+00:00",
"unit": "rmssd",
"value": 49
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-18T07:33:39.568058+00:00",
"unit": "stage",
"value": 0
},
{
"id": 1,
"timestamp": "2026-08-18T07:34:09.568067+00:00",
"unit": "stage",
"value": 1
},
{
"id": 2,
"timestamp": "2026-08-18T07:34:39.568076+00:00",
"unit": "stage",
"value": 3
},
{
"id": 3,
"timestamp": "2026-08-18T07:35:09.568083+00:00",
"unit": "stage",
"value": 2
},
{
"id": 4,
"timestamp": "2026-08-18T07:35:39.568091+00:00",
"unit": "stage",
"value": 1
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-18T07:33:39.568114+00:00",
"unit": "bpm",
"value": 13
},
{
"id": 1,
"timestamp": "2026-08-18T07:34:09.568122+00:00",
"unit": "bpm",
"value": 28
},
{
"id": 2,
"timestamp": "2026-08-18T07:34:39.568129+00:00",
"unit": "bpm",
"value": 19
},
{
"id": 3,
"timestamp": "2026-08-18T07:35:09.568143+00:00",
"unit": "bpm",
"value": 24
},
{
"id": 4,
"timestamp": "2026-08-18T07:35:39.568151+00:00",
"unit": "bpm",
"value": 23
}
]
}