Skip to content

Single Daily Sleep Document

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

Successful Response

Media typeapplication/json
PublicDailySleep

Public object defining daily sleep.

object
id
required

Unique identifier of the object.

string
>= 1 characters
contributors
required

Contributors for the daily sleep score.

object
deep_sleep
Any of:
integer
efficiency
Any of:
integer
latency
Any of:
integer
rem_sleep
Any of:
integer
restfulness
Any of:
integer
timing
Any of:
integer
total_sleep
Any of:
integer
day
required

Day that the daily sleep belongs to.

string
score
Any of:
integer
timestamp
required

Timestamp of the daily sleep.

string
Examplegenerated
{
"id": "example",
"contributors": {
"deep_sleep": 1,
"efficiency": 1,
"latency": 1,
"rem_sleep": 1,
"restfulness": 1,
"timing": 1,
"total_sleep": 1
},
"day": "example",
"score": 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.