Multiple Daily Readiness Documents

GET

/v2/usercollection/daily_readiness

curl --location --request GET 'https://api.ouraring.com/v2/usercollection/daily_readiness?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[PublicDailyReadiness]

object

data

required

Data

Array<object>

PublicDailyReadiness

Public object defining daily readiness.

object

id

required

Unique identifier of the object.

string

>= 1 characters

contributors

required

Contributors of the daily 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

day

required

Day that the daily readiness belongs to.

string

score

Any of:

integer

integer

null

null

temperature_deviation

Any of:

number

number

null

null

temperature_trend_deviation

Any of:

number

number

null

null

timestamp

required

Timestamp of the daily readiness.

string

next_token

required

Any of:

string

string

null

null

Example^generated

{
  "data": [
    {
      "id": "example",
      "contributors": {
        "activity_balance": 1,
        "body_temperature": 1,
        "hrv_balance": 1,
        "previous_day_activity": 1,
        "previous_night": 1,
        "recovery_index": 1,
        "resting_heart_rate": 1,
        "sleep_balance": 1,
        "sleep_regularity": 1
      },
      "day": "example",
      "score": 1,
      "temperature_deviation": 1,
      "temperature_trend_deviation": 1,
      "timestamp": "example"
    }
  ],
  "next_token": "example"
}

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.