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-12T19:55:48.705510+00:00",
      "unit": "bpm",
      "value": 44
    },
    {
      "id": 1,
      "timestamp": "2025-05-12T19:56:18.705536+00:00",
      "unit": "bpm",
      "value": 42
    },
    {
      "id": 2,
      "timestamp": "2025-05-12T19:56:48.705561+00:00",
      "unit": "bpm",
      "value": 133
    },
    {
      "id": 3,
      "timestamp": "2025-05-12T19:57:18.705600+00:00",
      "unit": "bpm",
      "value": 66
    },
    {
      "id": 4,
      "timestamp": "2025-05-12T19:57:48.705625+00:00",
      "unit": "bpm",
      "value": 46
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2025-05-12T19:55:48.705172+00:00",
      "unit": "rmssd",
      "value": 33
    },
    {
      "id": 1,
      "timestamp": "2025-05-12T19:56:18.705254+00:00",
      "unit": "rmssd",
      "value": 80
    },
    {
      "id": 2,
      "timestamp": "2025-05-12T19:56:48.705295+00:00",
      "unit": "rmssd",
      "value": 4
    },
    {
      "id": 3,
      "timestamp": "2025-05-12T19:57:18.705443+00:00",
      "unit": "rmssd",
      "value": 21
    },
    {
      "id": 4,
      "timestamp": "2025-05-12T19:57:48.705479+00:00",
      "unit": "rmssd",
      "value": 56
    }
  ],
  "hypnogram": [
    {
      "id": 0,
      "timestamp": "2025-05-12T19:55:48.705660+00:00",
      "unit": "stage",
      "value": 4
    },
    {
      "id": 1,
      "timestamp": "2025-05-12T19:56:18.705683+00:00",
      "unit": "stage",
      "value": 3
    },
    {
      "id": 2,
      "timestamp": "2025-05-12T19:56:48.705704+00:00",
      "unit": "stage",
      "value": 0
    },
    {
      "id": 3,
      "timestamp": "2025-05-12T19:57:18.705725+00:00",
      "unit": "stage",
      "value": -1
    },
    {
      "id": 4,
      "timestamp": "2025-05-12T19:57:48.705747+00:00",
      "unit": "stage",
      "value": 1
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2025-05-12T19:55:48.705768+00:00",
      "unit": "bpm",
      "value": 9
    },
    {
      "id": 1,
      "timestamp": "2025-05-12T19:56:18.705789+00:00",
      "unit": "bpm",
      "value": 24
    },
    {
      "id": 2,
      "timestamp": "2025-05-12T19:56:48.705809+00:00",
      "unit": "bpm",
      "value": 13
    },
    {
      "id": 3,
      "timestamp": "2025-05-12T19:57:18.705829+00:00",
      "unit": "bpm",
      "value": 11
    },
    {
      "id": 4,
      "timestamp": "2025-05-12T19:57:48.705849+00:00",
      "unit": "bpm",
      "value": 30
    }
  ]
}
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.