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-14T07:17:15.679186+00:00",
"unit": "bpm",
"value": 142
},
{
"id": 1,
"timestamp": "2026-08-14T07:17:45.679196+00:00",
"unit": "bpm",
"value": 44
},
{
"id": 2,
"timestamp": "2026-08-14T07:18:15.679205+00:00",
"unit": "bpm",
"value": 74
},
{
"id": 3,
"timestamp": "2026-08-14T07:18:45.679214+00:00",
"unit": "bpm",
"value": 19
},
{
"id": 4,
"timestamp": "2026-08-14T07:19:15.679222+00:00",
"unit": "bpm",
"value": 84
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-14T07:17:15.679027+00:00",
"unit": "rmssd",
"value": 24
},
{
"id": 1,
"timestamp": "2026-08-14T07:17:45.679121+00:00",
"unit": "rmssd",
"value": 83
},
{
"id": 2,
"timestamp": "2026-08-14T07:18:15.679146+00:00",
"unit": "rmssd",
"value": 96
},
{
"id": 3,
"timestamp": "2026-08-14T07:18:45.679163+00:00",
"unit": "rmssd",
"value": 85
},
{
"id": 4,
"timestamp": "2026-08-14T07:19:15.679175+00:00",
"unit": "rmssd",
"value": 26
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-14T07:17:15.679232+00:00",
"unit": "stage",
"value": 0
},
{
"id": 1,
"timestamp": "2026-08-14T07:17:45.679241+00:00",
"unit": "stage",
"value": 1
},
{
"id": 2,
"timestamp": "2026-08-14T07:18:15.679249+00:00",
"unit": "stage",
"value": 3
},
{
"id": 3,
"timestamp": "2026-08-14T07:18:45.679257+00:00",
"unit": "stage",
"value": 3
},
{
"id": 4,
"timestamp": "2026-08-14T07:19:15.679265+00:00",
"unit": "stage",
"value": -1
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-14T07:17:15.679273+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 1,
"timestamp": "2026-08-14T07:17:45.679281+00:00",
"unit": "bpm",
"value": 8
},
{
"id": 2,
"timestamp": "2026-08-14T07:18:15.679293+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 3,
"timestamp": "2026-08-14T07:18:45.679301+00:00",
"unit": "bpm",
"value": 9
},
{
"id": 4,
"timestamp": "2026-08-14T07:19:15.679308+00:00",
"unit": "bpm",
"value": 15
}
]
}