---
title: "Hypnogram"
method: GET
path: "/v2/timeseries/{user_id}/hypnogram"
tags: ["timeseries"]
deprecated: true
---

# Hypnogram

`GET /v2/timeseries/{user_id}/hypnogram`

> **Deprecated.**

## Path parameters

- `user_id` string, uuid, required

## Query parameters

- `provider` string — Provider oura/strava etc
- `start_date` string, required — Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00
- `end_date` string, nullable — Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59

## Response `200`

Successful Response

- ClientFacingHypnogramTimeseries[]
  - `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}

## 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)