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-05-28T21:41:07.239528+00:00",
      "unit": "bpm",
      "value": 186
    },
    {
      "id": 1,
      "timestamp": "2025-05-28T21:41:37.239560+00:00",
      "unit": "bpm",
      "value": 171
    },
    {
      "id": 2,
      "timestamp": "2025-05-28T21:42:07.239588+00:00",
      "unit": "bpm",
      "value": 4
    },
    {
      "id": 3,
      "timestamp": "2025-05-28T21:42:37.239629+00:00",
      "unit": "bpm",
      "value": 173
    },
    {
      "id": 4,
      "timestamp": "2025-05-28T21:43:07.239666+00:00",
      "unit": "bpm",
      "value": 164
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-05-28T21:41:07.239268+00:00",
      "unit": "rmssd",
      "value": 80
    },
    {
      "id": 1,
      "timestamp": "2025-05-28T21:41:37.239361+00:00",
      "unit": "rmssd",
      "value": 84
    },
    {
      "id": 2,
      "timestamp": "2025-05-28T21:42:07.239412+00:00",
      "unit": "rmssd",
      "value": 13
    },
    {
      "id": 3,
      "timestamp": "2025-05-28T21:42:37.239456+00:00",
      "unit": "rmssd",
      "value": 36
    },
    {
      "id": 4,
      "timestamp": "2025-05-28T21:43:07.239495+00:00",
      "unit": "rmssd",
      "value": 42
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-05-28T21:41:07.239696+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 1,
      "timestamp": "2025-05-28T21:41:37.239724+00:00",
      "unit": "stage",
      "value": 1
    },
    {
      "id": 2,
      "timestamp": "2025-05-28T21:42:07.239749+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 3,
      "timestamp": "2025-05-28T21:42:37.239774+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 4,
      "timestamp": "2025-05-28T21:43:07.239801+00:00",
      "unit": "stage",
      "value": 1
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-05-28T21:41:07.239826+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 1,
      "timestamp": "2025-05-28T21:41:37.239850+00:00",
      "unit": "bpm",
      "value": 28
    },
    {
      "id": 2,
      "timestamp": "2025-05-28T21:42:07.239872+00:00",
      "unit": "bpm",
      "value": 15
    },
    {
      "id": 3,
      "timestamp": "2025-05-28T21:42:37.239897+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 4,
      "timestamp": "2025-05-28T21:43:07.239919+00:00",
      "unit": "bpm",
      "value": 10
    }
  ]
}
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

200
application/json

Successful Response

The response is of type object.