Skip to content

Single Session Document

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

Successful Response

Media typeapplication/json
PublicSession

Public model defining a recorded Session.

object
id
required

Unique identifier of the object.

string
>= 1 characters
day
required

The date when the session occurred.

string
end_datetime
required

Timestamp indicating when the Moment ended.

string
heart_rate
Any of:
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
heart_rate_variability
Any of:
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
mood
Any of:
PublicMomentMood

Possible Moment moods.

string
Allowed values: bad worse same good great
motion_count
Any of:
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
start_datetime
required

Timestamp indicating when the Moment started.

string
type
required

Type of the Moment.

string
Allowed values: breathing meditation nap relaxation rest body_status
Example
{
"mood": "bad",
"type": "breathing"
}

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.