Single Sleep Time Document
GET
/v2/usercollection/sleep_time/{document_id}
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/sleep_time/2-5daccc095220cc5493a4e9c2b681ca941e' \--header 'Authorization: Bearer <token>'import requestsurl = 'https://api.ouraring.com/v2/usercollection/sleep_time/2-5daccc095220cc5493a4e9c2b681ca941e'headers = { 'Authorization': 'Bearer <token>'}response = requests.request('GET', url, headers=headers, params=params)print(response.text)var myHeaders = new Headers();myHeaders.append('Authorization', 'Bearer <token>');var requestOptions = { method: 'GET', headers: myHeaders,};fetch('https://api.ouraring.com/v2/usercollection/sleep_time/2-5daccc095220cc5493a4e9c2b681ca941e', requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log('error', error));OkHttpClient client = new OkHttpClient().newBuilder() .build();Request request = new Request.Builder() .url("https://api.ouraring.com/v2/usercollection/sleep_time/2-5daccc095220cc5493a4e9c2b681ca941e") .method("GET", null) .addHeader("Authorization", "Bearer <token>") .build();Response response = client.newCall(request).execute();Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”document_id
required
Document Id
string
Responses
Section titled “Responses”Successful Response
Media typeapplication/json
PublicSleepTime
Suggested bedtime for the user.
object
id
required
Unique identifier of the object.
string
day
required
Corresponding day for the sleep time.
string
optimal_bedtime
Any of:
PublicSleepTimeWindow
Object defining sleep time window
object
day_tz
required
Timezone offset in second from GMT of the day
integer
end_offset
required
End offset from midnight in second
integer
start_offset
required
Start offset from midnight in second
integer
null
recommendation
Any of:
PublicSleepTimeRecommendation
Possible public SleepTime recommendation.
string
null
status
Any of:
PublicSleepTimeStatus
Possible public SleepTime status.
string
null
Example
{ "recommendation": "improve_efficiency", "status": "not_enough_nights"}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>
ValidationErrorobject
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.