Skip to content

Single Daily Readiness Document

GET
/v2/usercollection/daily_readiness/{document_id}
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/daily_readiness/2-5daccc095220cc5493a4e9c2b681ca941e' \
--header 'Authorization: Bearer <token>'
document_id
required
Document Id
string

Successful Response

Media typeapplication/json
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
body_temperature
Any of:
integer
hrv_balance
Any of:
integer
previous_day_activity
Any of:
integer
previous_night
Any of:
integer
recovery_index
Any of:
integer
resting_heart_rate
Any of:
integer
sleep_balance
Any of:
integer
sleep_regularity
Any of:
integer
day
required

Day that the daily readiness belongs to.

string
score
Any of:
integer
temperature_deviation
Any of:
number
temperature_trend_deviation
Any of:
number
timestamp
required

Timestamp of the daily readiness.

string
Examplegenerated
{
"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"
}

Client Exception

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

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

Not Found

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
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}

Request Rate Limit Exceeded.