TRtryvital
timeseries

Get User Sleep Stream

Changed on

Get Sleep stream for a user_id

get/v2/timeseries/sleep/{sleep_id}/stream

Request

  • Base URL
    https://api.us.junction.com
  • URL
    https://api.us.junction.com/v2/timeseries/sleep/{sleep_id}/stream
  • Auth
    API key in header x-vital-api-key

Path parameters

sleep_idstring uuid required

The Vital Sleep ID

Response

Successful Response

Example response

{
  "heartrate": [
    {
      "id": 0,
      "timestamp": "2026-10-29T13:48:12.214689+00:00",
      "unit": "bpm",
      "value": 5
    },
    {
      "id": 1,
      "timestamp": "2026-10-29T13:48:42.214716+00:00",
      "unit": "bpm",
      "value": 183
    },
    {
      "id": 2,
      "timestamp": "2026-10-29T13:49:12.214733+00:00",
      "unit": "bpm",
      "value": 165
    },
    {
      "id": 3,
      "timestamp": "2026-10-29T13:49:42.214749+00:00",
      "unit": "bpm",
      "value": 189
    },
    {
      "id": 4,
      "timestamp": "2026-10-29T13:50:12.214766+00:00",
      "unit": "bpm",
      "value": 113
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2026-10-29T13:48:12.214372+00:00",
      "unit": "rmssd",
      "value": 9
    },
    {
      "id": 1,
      "timestamp": "2026-10-29T13:48:42.214553+00:00",
      "unit": "rmssd",
      "value": 78
    },
    {
      "id": 2,
      "timestamp": "2026-10-29T13:49:12.214591+00:00",
      "unit": "rmssd",
      "value": 4
    },
    {
      "id": 3,
      "timestamp": "2026-10-29T13:49:42.214646+00:00",
      "unit": "rmssd",
      "value": 11
    },
    {
      "id": 4,
      "timestamp": "2026-10-29T13:50:12.214668+00:00",
      "unit": "rmssd",
      "value": 24
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2026-10-29T13:48:12.214783+00:00",
      "unit": "bpm",
      "value": 11
    },
    {
      "id": 1,
      "timestamp": "2026-10-29T13:48:42.214803+00:00",
      "unit": "bpm",
      "value": 8
    },
    {
      "id": 2,
      "timestamp": "2026-10-29T13:49:12.214820+00:00",
      "unit": "bpm",
      "value": 14
    },
    {
      "id": 3,
      "timestamp": "2026-10-29T13:49:42.214837+00:00",
      "unit": "bpm",
      "value": 23
    },
    {
      "id": 4,
      "timestamp": "2026-10-29T13:50:12.214853+00:00",
      "unit": "bpm",
      "value": 10
    }
  ]
}

Changes