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-07-14T08:24:59.231081+00:00",
      "unit": "bpm",
      "value": 74
    },
    {
      "id": 1,
      "timestamp": "2025-07-14T08:25:29.231113+00:00",
      "unit": "bpm",
      "value": 117
    },
    {
      "id": 2,
      "timestamp": "2025-07-14T08:25:59.231142+00:00",
      "unit": "bpm",
      "value": 68
    },
    {
      "id": 3,
      "timestamp": "2025-07-14T08:26:29.231185+00:00",
      "unit": "bpm",
      "value": 57
    },
    {
      "id": 4,
      "timestamp": "2025-07-14T08:26:59.231215+00:00",
      "unit": "bpm",
      "value": 108
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-07-14T08:24:59.230814+00:00",
      "unit": "rmssd",
      "value": 13
    },
    {
      "id": 1,
      "timestamp": "2025-07-14T08:25:29.230901+00:00",
      "unit": "rmssd",
      "value": 11
    },
    {
      "id": 2,
      "timestamp": "2025-07-14T08:25:59.230948+00:00",
      "unit": "rmssd",
      "value": 82
    },
    {
      "id": 3,
      "timestamp": "2025-07-14T08:26:29.230992+00:00",
      "unit": "rmssd",
      "value": 98
    },
    {
      "id": 4,
      "timestamp": "2025-07-14T08:26:59.231042+00:00",
      "unit": "rmssd",
      "value": 40
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-07-14T08:24:59.231245+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 1,
      "timestamp": "2025-07-14T08:25:29.231273+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 2,
      "timestamp": "2025-07-14T08:25:59.231298+00:00",
      "unit": "stage",
      "value": 4
    },
    {
      "id": 3,
      "timestamp": "2025-07-14T08:26:29.231324+00:00",
      "unit": "stage",
      "value": 4
    },
    {
      "id": 4,
      "timestamp": "2025-07-14T08:26:59.231352+00:00",
      "unit": "stage",
      "value": 2
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-07-14T08:24:59.231378+00:00",
      "unit": "bpm",
      "value": 27
    },
    {
      "id": 1,
      "timestamp": "2025-07-14T08:25:29.231402+00:00",
      "unit": "bpm",
      "value": 8
    },
    {
      "id": 2,
      "timestamp": "2025-07-14T08:25:59.231426+00:00",
      "unit": "bpm",
      "value": 25
    },
    {
      "id": 3,
      "timestamp": "2025-07-14T08:26:29.231449+00:00",
      "unit": "bpm",
      "value": 14
    },
    {
      "id": 4,
      "timestamp": "2025-07-14T08:26:59.231473+00:00",
      "unit": "bpm",
      "value": 17
    }
  ]
}
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.