Skip to main content
GET
/
v2
/
timeseries
/
sleep
/
{sleep_id}
/
stream
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": "2025-12-03T22:08:33.471693+00:00",
      "unit": "bpm",
      "value": 64
    },
    {
      "id": 1,
      "timestamp": "2025-12-03T22:09:03.471717+00:00",
      "unit": "bpm",
      "value": 111
    },
    {
      "id": 2,
      "timestamp": "2025-12-03T22:09:33.471739+00:00",
      "unit": "bpm",
      "value": 125
    },
    {
      "id": 3,
      "timestamp": "2025-12-03T22:10:03.471773+00:00",
      "unit": "bpm",
      "value": 125
    },
    {
      "id": 4,
      "timestamp": "2025-12-03T22:10:33.471796+00:00",
      "unit": "bpm",
      "value": 168
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-12-03T22:08:33.471482+00:00",
      "unit": "rmssd",
      "value": 42
    },
    {
      "id": 1,
      "timestamp": "2025-12-03T22:09:03.471565+00:00",
      "unit": "rmssd",
      "value": 85
    },
    {
      "id": 2,
      "timestamp": "2025-12-03T22:09:33.471601+00:00",
      "unit": "rmssd",
      "value": 57
    },
    {
      "id": 3,
      "timestamp": "2025-12-03T22:10:03.471639+00:00",
      "unit": "rmssd",
      "value": 22
    },
    {
      "id": 4,
      "timestamp": "2025-12-03T22:10:33.471667+00:00",
      "unit": "rmssd",
      "value": 54
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-12-03T22:08:33.471834+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 1,
      "timestamp": "2025-12-03T22:09:03.471859+00:00",
      "unit": "stage",
      "value": 1
    },
    {
      "id": 2,
      "timestamp": "2025-12-03T22:09:33.471879+00:00",
      "unit": "stage",
      "value": 1
    },
    {
      "id": 3,
      "timestamp": "2025-12-03T22:10:03.471899+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 4,
      "timestamp": "2025-12-03T22:10:33.471919+00:00",
      "unit": "stage",
      "value": 1
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-12-03T22:08:33.471939+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 1,
      "timestamp": "2025-12-03T22:09:03.471957+00:00",
      "unit": "bpm",
      "value": 27
    },
    {
      "id": 2,
      "timestamp": "2025-12-03T22:09:33.471980+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 3,
      "timestamp": "2025-12-03T22:10:03.472001+00:00",
      "unit": "bpm",
      "value": 17
    },
    {
      "id": 4,
      "timestamp": "2025-12-03T22:10:33.472025+00:00",
      "unit": "bpm",
      "value": 24
    }
  ]
}
curl --request GET \
    --url {{BASE_URL}}/v2/summary/sleep/{sleep_id}/stream \
    --header 'Accept: application/json' \
    --header 'x-vital-api-key: <API_KEY>'

Authorizations

x-vital-api-key
string
header
required

Vital Team API Key

Path Parameters

sleep_id
string
required

The Vital Sleep ID

Response

Successful Response

hrv
ClientFacingHRVTimeseries · object[] | null
heartrate
ClientFacingHeartRateTimeseries · object[] | null
hypnogram
ClientFacingHypnogramTimeseries · object[] | null
respiratory_rate
ClientFacingRespiratoryRateTimeseries · object[] | null