timeseries

Get User Sleep Stream

Get Sleep stream for a user_id

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

Path parameters

sleep_idstring uuid required

The Vital Sleep ID

The Vital Sleep ID

Response

Successful Response

Example response

{
  "heartrate": [
    {
      "id": 0,
      "timestamp": "2026-09-27T16:26:19.625182+00:00",
      "unit": "bpm",
      "value": 17
    },
    {
      "id": 1,
      "timestamp": "2026-09-27T16:26:49.625192+00:00",
      "unit": "bpm",
      "value": 115
    },
    {
      "id": 2,
      "timestamp": "2026-09-27T16:27:19.625200+00:00",
      "unit": "bpm",
      "value": 151
    },
    {
      "id": 3,
      "timestamp": "2026-09-27T16:27:49.625208+00:00",
      "unit": "bpm",
      "value": 46
    },
    {
      "id": 4,
      "timestamp": "2026-09-27T16:28:19.625215+00:00",
      "unit": "bpm",
      "value": 127
    }
  ],
  "hrv": [
    {
      "id": 0,
      "timestamp": "2026-09-27T16:26:19.625063+00:00",
      "unit": "rmssd",
      "value": 15
    },
    {
      "id": 1,
      "timestamp": "2026-09-27T16:26:49.625118+00:00",
      "unit": "rmssd",
      "value": 78
    },
    {
      "id": 2,
      "timestamp": "2026-09-27T16:27:19.625139+00:00",
      "unit": "rmssd",
      "value": 86
    },
    {
      "id": 3,
      "timestamp": "2026-09-27T16:27:49.625161+00:00",
      "unit": "rmssd",
      "value": 82
    },
    {
      "id": 4,
      "timestamp": "2026-09-27T16:28:19.625173+00:00",
      "unit": "rmssd",
      "value": 21
    }
  ],
  "respiratory_rate": [
    {
      "id": 0,
      "timestamp": "2026-09-27T16:26:19.625223+00:00",
      "unit": "bpm",
      "value": 23
    },
    {
      "id": 1,
      "timestamp": "2026-09-27T16:26:49.625238+00:00",
      "unit": "bpm",
      "value": 8
    },
    {
      "id": 2,
      "timestamp": "2026-09-27T16:27:19.625247+00:00",
      "unit": "bpm",
      "value": 19
    },
    {
      "id": 3,
      "timestamp": "2026-09-27T16:27:49.625259+00:00",
      "unit": "bpm",
      "value": 22
    },
    {
      "id": 4,
      "timestamp": "2026-09-27T16:28:19.625266+00:00",
      "unit": "bpm",
      "value": 28
    }
  ]
}

Changes

Changed in 1 of the 136 revisions of this API.1

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog