Multiple Sleep Documents

GET

/v2/usercollection/sleep

curl --location --request GET 'https://api.ouraring.com/v2/usercollection/sleep?start_date=2021-11-01&end_date=2021-12-01&fields=day,score' \
--header 'Authorization: Bearer <token>'

• Oura API

Authorizations

• BearerAuth

Parameters

Query Parameters

start_date

Start Date

string format: date

end_date

End Date

string format: date

next_token

Any of:

string

string

null

null

fields

Any of:

string

string

null

null

Comma-separated list of fields to include in the response, in addition to the always returned fields. Defaults to all fields if not provided.

Responses

200

Successful Response

Media typeapplication/json

MultiDocumentResponse[PublicModifiedSleepModel]

object

data

required

Data

Array<object>

PublicModifiedSleepModel

object

id

required

Unique identifier of the object.

string

>= 1 characters

average_breath

Any of:

number

number

null

null

average_heart_rate

Any of:

number

number

null

null

average_hrv

Any of:

integer

integer

null

null

awake_time

Any of:

integer

integer

null

null

bedtime_end

required

Bedtime end of the sleep.

string

bedtime_start

required

Bedtime start of the sleep.

string

day

required

Day that the sleep belongs to.

string

deep_sleep_duration

Any of:

integer

integer

null

null

efficiency

Any of:

integer

integer

null

null

heart_rate

Any of:

PublicSample

PublicSample

Object defining a recorded sample.

object

interval

required

Interval in seconds between the sampled items.

number

items

required

Recorded sample items.

Array

timestamp

required

Timestamp when the sample recording started.

string

null

null

hrv

Any of:

PublicSample

PublicSample

Object defining a recorded sample.

object

interval

required

Interval in seconds between the sampled items.

number

items

required

Recorded sample items.

Array

timestamp

required

Timestamp when the sample recording started.

string

null

null

latency

Any of:

integer

integer

null

null

light_sleep_duration

Any of:

integer

integer

null

null

low_battery_alert

required

Flag indicating if a low battery alert occurred.

boolean

lowest_heart_rate

Any of:

integer

integer

null

null

movement_30_sec

Any of:

string

string

null

null

period

required

ECore sleep period identifier.

integer

readiness

Any of:

PublicReadiness

PublicReadiness

Object defining readiness.

object

contributors

required

Contributors of the readiness score.

object

activity_balance

Any of:

integer

integer

null

null

body_temperature

Any of:

integer

integer

null

null

hrv_balance

Any of:

integer

integer

null

null

previous_day_activity

Any of:

integer

integer

null

null

previous_night

Any of:

integer

integer

null

null

recovery_index

Any of:

integer

integer

null

null

resting_heart_rate

Any of:

integer

integer

null

null

sleep_balance

Any of:

integer

integer

null

null

sleep_regularity

Any of:

integer

integer

null

null

score

Any of:

integer

integer

null

null

temperature_deviation

Any of:

number

number

null

null

temperature_trend_deviation

Any of:

number

number

null

null

null

null

readiness_score_delta

Any of:

integer

integer

null

null

rem_sleep_duration

Any of:

integer

integer

null

null

restless_periods

Any of:

integer

integer

null

null

sleep_algorithm_version

Any of:

PublicSleepAlgorithmVersion

PublicSleepAlgorithmVersion

Oura Sleep Staging Algorithms. v1 = original aka legacy aka OSSA 1.0, v2 = latest sleep algorithm

string

Allowed values: v1 v2

null

null

sleep_analysis_reason

Any of:

PublicSleepAnalysisReason

PublicSleepAnalysisReason

Possible sleep analysis reasons.

string

Allowed values: foreground_sleep_analysis bedtime_edit background_sleep_analysis background_created_foreground_updated

null

null

sleep_phase_30_sec

Any of:

string

string

null

null

sleep_phase_5_min

Any of:

string

string

null

null

sleep_score_delta

Any of:

integer

integer

null

null

time_in_bed

required

Duration spent in bed in seconds.

integer

total_sleep_duration

Any of:

integer

integer

null

null

type

Any of:

PublicSleepType

PublicSleepType

Possible sleep period types. ‘deleted’ = deleted sleep by user. ‘sleep’ = user confirmed sleep / nap, min 15 minutes, max 3 hours, contributes to daily scores ‘late_nap’ = user confirmed sleep / nap, min 15 minutes, ended after sleep day change (6 pm), contributes to next days daily scores ‘long_sleep’ = sleep that is long enough (>3h) to automatically contribute to daily scores ‘rest’ = Falsely detected sleep / nap, rejected in confirm prompt by user

string

Allowed values: deleted sleep long_sleep late_nap rest

null

null

ring_id

Any of:

string

string

null

null

app_sleep_phase_5_min

Any of:

string

string

null

null

next_token

required

Any of:

string

string

null

null

Example

{
  "data": [
    {
      "sleep_algorithm_version": "v1",
      "sleep_analysis_reason": "foreground_sleep_analysis",
      "type": "deleted"
    }
  ]
}

400

Client Exception

401

Unauthorized access exception. Usually means the access token is expired, malformed or revoked.

403

Access forbidden. Usually means the user’s subscription to Oura has expired and their data is not available via the API.

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

429

Request Rate Limit Exceeded.