Sign in

v74

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-072076961.5 MB
timeseries

Hypnogram

get/v2/timeseries/{user_id}/hypnogram

Path parameters

user_idstring uuid required

Query parameters

providerstring

Provider oura/strava etc

Provider oura/strava etc

start_datestring 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

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_datestring 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

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

Successful Response

idinteger nullable

Deprecated

timezone_offsetinteger 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.

typestring nullable

Type is always null for this resource.

unitstring required

enum: 1: deep, 2: light, 3: rem, 4: awake, -1: missing_data.

timestampstring date-time required

Depracated. The start time (inclusive) of the interval.

startstring date-time required

The start time (inclusive) of the interval.

endstring date-time required

The end time (exclusive) of the interval.

valuenumber required

Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "manual": 5, "missing_data": -1}

Example response

[
  {
    "end": "2023-02-13T14:57:24+00:00",
    "start": "2023-02-13T14:30:52+00:00",
    "unit": "stage",
    "value": 1
  }
]