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-13T13:42:13.298604+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 1,
"timestamp": "2026-08-13T13:42:43.298614+00:00",
"unit": "bpm",
"value": 160
},
{
"id": 2,
"timestamp": "2026-08-13T13:43:13.298623+00:00",
"unit": "bpm",
"value": 163
},
{
"id": 3,
"timestamp": "2026-08-13T13:43:43.298630+00:00",
"unit": "bpm",
"value": 67
},
{
"id": 4,
"timestamp": "2026-08-13T13:44:13.298637+00:00",
"unit": "bpm",
"value": 127
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-08-13T13:42:13.298475+00:00",
"unit": "rmssd",
"value": 14
},
{
"id": 1,
"timestamp": "2026-08-13T13:42:43.298544+00:00",
"unit": "rmssd",
"value": 32
},
{
"id": 2,
"timestamp": "2026-08-13T13:43:13.298568+00:00",
"unit": "rmssd",
"value": 36
},
{
"id": 3,
"timestamp": "2026-08-13T13:43:43.298583+00:00",
"unit": "rmssd",
"value": 66
},
{
"id": 4,
"timestamp": "2026-08-13T13:44:13.298593+00:00",
"unit": "rmssd",
"value": 9
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-08-13T13:42:13.298645+00:00",
"unit": "stage",
"value": 4
},
{
"id": 1,
"timestamp": "2026-08-13T13:42:43.298653+00:00",
"unit": "stage",
"value": 1
},
{
"id": 2,
"timestamp": "2026-08-13T13:43:13.298673+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-08-13T13:43:43.298680+00:00",
"unit": "stage",
"value": 2
},
{
"id": 4,
"timestamp": "2026-08-13T13:44:13.298687+00:00",
"unit": "stage",
"value": 4
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-08-13T13:42:13.298694+00:00",
"unit": "bpm",
"value": 19
},
{
"id": 1,
"timestamp": "2026-08-13T13:42:43.298701+00:00",
"unit": "bpm",
"value": 26
},
{
"id": 2,
"timestamp": "2026-08-13T13:43:13.298708+00:00",
"unit": "bpm",
"value": 25
},
{
"id": 3,
"timestamp": "2026-08-13T13:43:43.298714+00:00",
"unit": "bpm",
"value": 17
},
{
"id": 4,
"timestamp": "2026-08-13T13:44:13.298721+00:00",
"unit": "bpm",
"value": 12
}
]
}