Sleep
Stream
Get Sleep stream for a user_id
GET
/v2/timeseries/sleep/{sleep_id}/stream
x-vital-api-key*
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"hrv": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722013+00:00",
"value": 98,
"type": null,
"unit": "rmssd"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722058+00:00",
"value": 44,
"type": null,
"unit": "rmssd"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722075+00:00",
"value": 75,
"type": null,
"unit": "rmssd"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722089+00:00",
"value": 100,
"type": null,
"unit": "rmssd"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722101+00:00",
"value": 59,
"type": null,
"unit": "rmssd"
}
],
"heartrate": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722112+00:00",
"value": 29,
"type": null,
"unit": "bpm"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722124+00:00",
"value": 162,
"type": null,
"unit": "bpm"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722135+00:00",
"value": 75,
"type": null,
"unit": "bpm"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722146+00:00",
"value": 11,
"type": null,
"unit": "bpm"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722157+00:00",
"value": 41,
"type": null,
"unit": "bpm"
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722168+00:00",
"start": "2022-08-04T12:42:45.722168+00:00",
"end": "2022-08-04T12:43:15.722179+00:00",
"value": 1,
"type": null,
"unit": "stage"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722179+00:00",
"start": "2022-08-04T12:43:15.722179+00:00",
"end": "2022-08-04T12:43:45.722190+00:00",
"value": 0,
"type": null,
"unit": "stage"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722190+00:00",
"start": "2022-08-04T12:43:45.722190+00:00",
"end": "2022-08-04T12:44:15.722201+00:00",
"value": 4,
"type": null,
"unit": "stage"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722201+00:00",
"start": "2022-08-04T12:44:15.722201+00:00",
"end": "2022-08-04T12:44:45.722212+00:00",
"value": 0,
"type": null,
"unit": "stage"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722212+00:00",
"start": "2022-08-04T12:44:45.722212+00:00",
"end": "2022-08-04T12:42:45.722223+00:00",
"value": 4,
"type": null,
"unit": "stage"
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722223+00:00",
"value": 30,
"type": null,
"unit": "bpm"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722234+00:00",
"value": 29,
"type": null,
"unit": "bpm"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722245+00:00",
"value": 19,
"type": null,
"unit": "bpm"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722256+00:00",
"value": 14,
"type": null,
"unit": "bpm"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722266+00:00",
"value": 18,
"type": null,
"unit": "bpm"
}
]
}
Path Parameters
sleep_idrequired
string
The Vital Sleep ID
Response
200 - application/json
hrv
object[]
heartrate
object[]
hypnogram
object[]
respiratory_rate
object[]
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"hrv": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722013+00:00",
"value": 98,
"type": null,
"unit": "rmssd"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722058+00:00",
"value": 44,
"type": null,
"unit": "rmssd"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722075+00:00",
"value": 75,
"type": null,
"unit": "rmssd"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722089+00:00",
"value": 100,
"type": null,
"unit": "rmssd"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722101+00:00",
"value": 59,
"type": null,
"unit": "rmssd"
}
],
"heartrate": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722112+00:00",
"value": 29,
"type": null,
"unit": "bpm"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722124+00:00",
"value": 162,
"type": null,
"unit": "bpm"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722135+00:00",
"value": 75,
"type": null,
"unit": "bpm"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722146+00:00",
"value": 11,
"type": null,
"unit": "bpm"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722157+00:00",
"value": 41,
"type": null,
"unit": "bpm"
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722168+00:00",
"start": "2022-08-04T12:42:45.722168+00:00",
"end": "2022-08-04T12:43:15.722179+00:00",
"value": 1,
"type": null,
"unit": "stage"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722179+00:00",
"start": "2022-08-04T12:43:15.722179+00:00",
"end": "2022-08-04T12:43:45.722190+00:00",
"value": 0,
"type": null,
"unit": "stage"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722190+00:00",
"start": "2022-08-04T12:43:45.722190+00:00",
"end": "2022-08-04T12:44:15.722201+00:00",
"value": 4,
"type": null,
"unit": "stage"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722201+00:00",
"start": "2022-08-04T12:44:15.722201+00:00",
"end": "2022-08-04T12:44:45.722212+00:00",
"value": 0,
"type": null,
"unit": "stage"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722212+00:00",
"start": "2022-08-04T12:44:45.722212+00:00",
"end": "2022-08-04T12:42:45.722223+00:00",
"value": 4,
"type": null,
"unit": "stage"
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2022-08-04T12:42:45.722223+00:00",
"value": 30,
"type": null,
"unit": "bpm"
},
{
"id": 1,
"timestamp": "2022-08-04T12:43:15.722234+00:00",
"value": 29,
"type": null,
"unit": "bpm"
},
{
"id": 2,
"timestamp": "2022-08-04T12:43:45.722245+00:00",
"value": 19,
"type": null,
"unit": "bpm"
},
{
"id": 3,
"timestamp": "2022-08-04T12:44:15.722256+00:00",
"value": 14,
"type": null,
"unit": "bpm"
},
{
"id": 4,
"timestamp": "2022-08-04T12:44:45.722266+00:00",
"value": 18,
"type": null,
"unit": "bpm"
}
]
}