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-31T13:52:37.147761+00:00",
"unit": "bpm",
"value": 115
},
{
"id": 1,
"timestamp": "2026-08-31T13:53:07.147771+00:00",
"unit": "bpm",
"value": 139
},
{
"id": 2,
"timestamp": "2026-08-31T13:53:37.147792+00:00",
"unit": "bpm",
"value": 17
},
{
"id": 3,
"timestamp": "2026-08-31T13:54:07.147803+00:00",
"unit": "bpm",
"value": 20
},
{
"id": 4,
"timestamp": "2026-08-31T13:54:37.147811+00:00",
"unit": "bpm",
"value": 30
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-31T13:52:37.147628+00:00",
"unit": "rmssd",
"value": 19
},
{
"id": 1,
"timestamp": "2026-08-31T13:53:07.147701+00:00",
"unit": "rmssd",
"value": 71
},
{
"id": 2,
"timestamp": "2026-08-31T13:53:37.147723+00:00",
"unit": "rmssd",
"value": 87
},
{
"id": 3,
"timestamp": "2026-08-31T13:54:07.147739+00:00",
"unit": "rmssd",
"value": 45
},
{
"id": 4,
"timestamp": "2026-08-31T13:54:37.147750+00:00",
"unit": "rmssd",
"value": 3
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-31T13:52:37.147820+00:00",
"unit": "stage",
"value": 2
},
{
"id": 1,
"timestamp": "2026-08-31T13:53:07.147829+00:00",
"unit": "stage",
"value": -1
},
{
"id": 2,
"timestamp": "2026-08-31T13:53:37.147837+00:00",
"unit": "stage",
"value": 2
},
{
"id": 3,
"timestamp": "2026-08-31T13:54:07.147846+00:00",
"unit": "stage",
"value": 4
},
{
"id": 4,
"timestamp": "2026-08-31T13:54:37.147855+00:00",
"unit": "stage",
"value": -1
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-31T13:52:37.147863+00:00",
"unit": "bpm",
"value": 10
},
{
"id": 1,
"timestamp": "2026-08-31T13:53:07.147871+00:00",
"unit": "bpm",
"value": 29
},
{
"id": 2,
"timestamp": "2026-08-31T13:53:37.147879+00:00",
"unit": "bpm",
"value": 15
},
{
"id": 3,
"timestamp": "2026-08-31T13:54:07.147886+00:00",
"unit": "bpm",
"value": 18
},
{
"id": 4,
"timestamp": "2026-08-31T13:54:37.147893+00:00",
"unit": "bpm",
"value": 18
}
]
}Changes
No recorded changes to this endpoint across all 95 revisions of this API.