curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"heartrate": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408697+00:00",
"unit": "bpm",
"value": 163
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408720+00:00",
"unit": "bpm",
"value": 91
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408746+00:00",
"unit": "bpm",
"value": 121
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408781+00:00",
"unit": "bpm",
"value": 132
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408803+00:00",
"unit": "bpm",
"value": 77
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408502+00:00",
"unit": "rmssd",
"value": 82
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408575+00:00",
"unit": "rmssd",
"value": 88
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408609+00:00",
"unit": "rmssd",
"value": 54
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408644+00:00",
"unit": "rmssd",
"value": 29
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408672+00:00",
"unit": "rmssd",
"value": 6
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408823+00:00",
"unit": "stage",
"value": 4
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408841+00:00",
"unit": "stage",
"value": 2
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408859+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408881+00:00",
"unit": "stage",
"value": 2
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408900+00:00",
"unit": "stage",
"value": 2
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408918+00:00",
"unit": "bpm",
"value": 15
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408935+00:00",
"unit": "bpm",
"value": 12
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408952+00:00",
"unit": "bpm",
"value": 25
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408988+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.409007+00:00",
"unit": "bpm",
"value": 12
}
]
}Get Sleep stream for a user_id
curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
{
"heartrate": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408697+00:00",
"unit": "bpm",
"value": 163
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408720+00:00",
"unit": "bpm",
"value": 91
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408746+00:00",
"unit": "bpm",
"value": 121
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408781+00:00",
"unit": "bpm",
"value": 132
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408803+00:00",
"unit": "bpm",
"value": 77
}
],
"hrv": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408502+00:00",
"unit": "rmssd",
"value": 82
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408575+00:00",
"unit": "rmssd",
"value": 88
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408609+00:00",
"unit": "rmssd",
"value": 54
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408644+00:00",
"unit": "rmssd",
"value": 29
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408672+00:00",
"unit": "rmssd",
"value": 6
}
],
"hypnogram": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408823+00:00",
"unit": "stage",
"value": 4
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408841+00:00",
"unit": "stage",
"value": 2
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408859+00:00",
"unit": "stage",
"value": 4
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408881+00:00",
"unit": "stage",
"value": 2
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.408900+00:00",
"unit": "stage",
"value": 2
}
],
"respiratory_rate": [
{
"id": 0,
"timestamp": "2026-01-30T16:49:34.408918+00:00",
"unit": "bpm",
"value": 15
},
{
"id": 1,
"timestamp": "2026-01-30T16:50:04.408935+00:00",
"unit": "bpm",
"value": 12
},
{
"id": 2,
"timestamp": "2026-01-30T16:50:34.408952+00:00",
"unit": "bpm",
"value": 25
},
{
"id": 3,
"timestamp": "2026-01-30T16:51:04.408988+00:00",
"unit": "bpm",
"value": 11
},
{
"id": 4,
"timestamp": "2026-01-30T16:51:34.409007+00:00",
"unit": "bpm",
"value": 12
}
]
}curl --request GET \
--url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
--header 'Accept: application/json' \
--header 'x-vital-api-key: <API_KEY>'
Vital Team API Key
The Vital Sleep ID
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?