---
title: "Get User Sleep Stream"
method: GET
path: "/v2/timeseries/sleep/{sleep_id}/stream"
tags: ["timeseries"]
---

# Get User Sleep Stream

`GET /v2/timeseries/sleep/{sleep_id}/stream`

Get Sleep stream for a user_id

## Path parameters

- `sleep_id` string, uuid, required — The Vital Sleep ID

## Response `200`

Successful Response

- ClientFacingSleepStream
  - `hrv` ClientFacingHRVTimeseries[], nullable
    - `id` integer, nullable — Deprecated
    - `timezone_offset` integer, nullable — Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
    - `type` string, nullable — Type is always null for this resource.
    - `unit` string, required — Measured in rmssd.
    - `timestamp` string, date-time, required — The timestamp of the measurement.
    - `value` number, required — HRV calculated using rmssd during sleep
  - `heartrate` ClientFacingHeartRateTimeseries[], nullable
    - `id` integer, nullable — Deprecated
    - `timezone_offset` integer, nullable — Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
    - `type` string, nullable — Type is always null for this resource.
    - `unit` string, required — Measured in bpm.
    - `timestamp` string, date-time, required — The timestamp of the measurement.
    - `value` number, required — Heart rate in bpm
  - `hypnogram` ClientFacingHypnogramTimeseries[], nullable
    - `id` integer, nullable — Deprecated
    - `timezone_offset` integer, nullable — Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
    - `type` string, nullable — Type is always null for this resource.
    - `unit` string, required — enum: 1: deep, 2: light, 3: rem, 4: awake, -1: missing_data.
    - `timestamp` string, date-time, required — Depracated. The start time (inclusive) of the interval.
    - `start` string, date-time, required — The start time (inclusive) of the interval.
    - `end` string, date-time, required — The end time (exclusive) of the interval.
    - `value` number, required — Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "manual": 5, "missing_data": -1}
  - `respiratory_rate` ClientFacingRespiratoryRateTimeseries[], nullable
    - `id` integer, nullable — Deprecated
    - `timezone_offset` integer, nullable — Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source.
    - `type` string, nullable — Type is always null for this resource.
    - `unit` string, required — Measured in bpm.
    - `timestamp` string, date-time, required — The timestamp of the measurement.
    - `value` number, required — Average respiratory rate::breaths per minute

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/tryvital/apis/junction-api.md) · [All operations](https://skmtc.net/tryvital/apis/junction-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tryvital/junction-api/versions/d28f5cec7d79/schema)