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-12T13:11:54.590180+00:00",
"unit": "bpm",
"value": 101
},
{
"id": 1,
"timestamp": "2026-08-12T13:12:24.590189+00:00",
"unit": "bpm",
"value": 173
},
{
"id": 2,
"timestamp": "2026-08-12T13:12:54.590197+00:00",
"unit": "bpm",
"value": 113
},
{
"id": 3,
"timestamp": "2026-08-12T13:13:24.590204+00:00",
"unit": "bpm",
"value": 140
},
{
"id": 4,
"timestamp": "2026-08-12T13:13:54.590212+00:00",
"unit": "bpm",
"value": 3
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-12T13:11:54.590068+00:00",
"unit": "rmssd",
"value": 67
},
{
"id": 1,
"timestamp": "2026-08-12T13:12:24.590126+00:00",
"unit": "rmssd",
"value": 45
},
{
"id": 2,
"timestamp": "2026-08-12T13:12:54.590146+00:00",
"unit": "rmssd",
"value": 80
},
{
"id": 3,
"timestamp": "2026-08-12T13:13:24.590160+00:00",
"unit": "rmssd",
"value": 10
},
{
"id": 4,
"timestamp": "2026-08-12T13:13:54.590170+00:00",
"unit": "rmssd",
"value": 50
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-12T13:11:54.590219+00:00",
"unit": "stage",
"value": 3
},
{
"id": 1,
"timestamp": "2026-08-12T13:12:24.590229+00:00",
"unit": "stage",
"value": 0
},
{
"id": 2,
"timestamp": "2026-08-12T13:12:54.590236+00:00",
"unit": "stage",
"value": 0
},
{
"id": 3,
"timestamp": "2026-08-12T13:13:24.590243+00:00",
"unit": "stage",
"value": 1
},
{
"id": 4,
"timestamp": "2026-08-12T13:13:54.590250+00:00",
"unit": "stage",
"value": 3
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-12T13:11:54.590258+00:00",
"unit": "bpm",
"value": 30
},
{
"id": 1,
"timestamp": "2026-08-12T13:12:24.590265+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 2,
"timestamp": "2026-08-12T13:12:54.590272+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 3,
"timestamp": "2026-08-12T13:13:24.590278+00:00",
"unit": "bpm",
"value": 18
},
{
"id": 4,
"timestamp": "2026-08-12T13:13:54.590285+00:00",
"unit": "bpm",
"value": 14
}
]
}