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-10T21:52:02.575250+00:00",
"unit": "bpm",
"value": 69
},
{
"id": 1,
"timestamp": "2026-08-10T21:52:32.575261+00:00",
"unit": "bpm",
"value": 165
},
{
"id": 2,
"timestamp": "2026-08-10T21:53:02.575296+00:00",
"unit": "bpm",
"value": 160
},
{
"id": 3,
"timestamp": "2026-08-10T21:53:32.575306+00:00",
"unit": "bpm",
"value": 24
},
{
"id": 4,
"timestamp": "2026-08-10T21:54:02.575315+00:00",
"unit": "bpm",
"value": 62
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-10T21:52:02.575065+00:00",
"unit": "rmssd",
"value": 70
},
{
"id": 1,
"timestamp": "2026-08-10T21:52:32.575176+00:00",
"unit": "rmssd",
"value": 96
},
{
"id": 2,
"timestamp": "2026-08-10T21:53:02.575207+00:00",
"unit": "rmssd",
"value": 59
},
{
"id": 3,
"timestamp": "2026-08-10T21:53:32.575226+00:00",
"unit": "rmssd",
"value": 83
},
{
"id": 4,
"timestamp": "2026-08-10T21:54:02.575238+00:00",
"unit": "rmssd",
"value": 29
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-10T21:52:02.575324+00:00",
"unit": "stage",
"value": -1
},
{
"id": 1,
"timestamp": "2026-08-10T21:52:32.575333+00:00",
"unit": "stage",
"value": 4
},
{
"id": 2,
"timestamp": "2026-08-10T21:53:02.575342+00:00",
"unit": "stage",
"value": 3
},
{
"id": 3,
"timestamp": "2026-08-10T21:53:32.575350+00:00",
"unit": "stage",
"value": 3
},
{
"id": 4,
"timestamp": "2026-08-10T21:54:02.575361+00:00",
"unit": "stage",
"value": -1
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-10T21:52:02.575369+00:00",
"unit": "bpm",
"value": 8
},
{
"id": 1,
"timestamp": "2026-08-10T21:52:32.575378+00:00",
"unit": "bpm",
"value": 18
},
{
"id": 2,
"timestamp": "2026-08-10T21:53:02.575386+00:00",
"unit": "bpm",
"value": 24
},
{
"id": 3,
"timestamp": "2026-08-10T21:53:32.575396+00:00",
"unit": "bpm",
"value": 17
},
{
"id": 4,
"timestamp": "2026-08-10T21:54:02.575403+00:00",
"unit": "bpm",
"value": 12
}
]
}