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-12T18:00:30.317827+00:00",
"unit": "bpm",
"value": 95
},
{
"id": 1,
"timestamp": "2026-08-12T18:01:00.317837+00:00",
"unit": "bpm",
"value": 72
},
{
"id": 2,
"timestamp": "2026-08-12T18:01:30.317846+00:00",
"unit": "bpm",
"value": 38
},
{
"id": 3,
"timestamp": "2026-08-12T18:02:00.317854+00:00",
"unit": "bpm",
"value": 125
},
{
"id": 4,
"timestamp": "2026-08-12T18:02:30.317862+00:00",
"unit": "bpm",
"value": 108
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-12T18:00:30.317678+00:00",
"unit": "rmssd",
"value": 18
},
{
"id": 1,
"timestamp": "2026-08-12T18:01:00.317765+00:00",
"unit": "rmssd",
"value": 33
},
{
"id": 2,
"timestamp": "2026-08-12T18:01:30.317788+00:00",
"unit": "rmssd",
"value": 46
},
{
"id": 3,
"timestamp": "2026-08-12T18:02:00.317805+00:00",
"unit": "rmssd",
"value": 24
},
{
"id": 4,
"timestamp": "2026-08-12T18:02:30.317816+00:00",
"unit": "rmssd",
"value": 67
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-12T18:00:30.317871+00:00",
"unit": "stage",
"value": -1
},
{
"id": 1,
"timestamp": "2026-08-12T18:01:00.317879+00:00",
"unit": "stage",
"value": 3
},
{
"id": 2,
"timestamp": "2026-08-12T18:01:30.317891+00:00",
"unit": "stage",
"value": 3
},
{
"id": 3,
"timestamp": "2026-08-12T18:02:00.317899+00:00",
"unit": "stage",
"value": 2
},
{
"id": 4,
"timestamp": "2026-08-12T18:02:30.317906+00:00",
"unit": "stage",
"value": 1
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-12T18:00:30.317914+00:00",
"unit": "bpm",
"value": 30
},
{
"id": 1,
"timestamp": "2026-08-12T18:01:00.317921+00:00",
"unit": "bpm",
"value": 30
},
{
"id": 2,
"timestamp": "2026-08-12T18:01:30.317928+00:00",
"unit": "bpm",
"value": 24
},
{
"id": 3,
"timestamp": "2026-08-12T18:02:00.317936+00:00",
"unit": "bpm",
"value": 16
},
{
"id": 4,
"timestamp": "2026-08-12T18:02:30.317943+00:00",
"unit": "bpm",
"value": 9
}
]
}