Skip to content

Multiple Daily Spo2 Documents

GET
/v2/usercollection/daily_spo2
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/daily_spo2?start_date=2021-11-01&end_date=2021-12-01&fields=day,score' \
--header 'Authorization: Bearer <token>'
start_date
Start Date
string format: date
end_date
End Date
string format: date
next_token
Any of:
string
fields
Any of:
string

Comma-separated list of fields to include in the response, in addition to the always returned fields. Defaults to all fields if not provided.

Successful Response

Media typeapplication/json
MultiDocumentResponse[PublicDailySpO2]
object
data
required
Data
Array<object>
PublicDailySpO2

Daily SpO2 (Oxygen saturation).

object
id
required

Unique identifier of the object.

string
>= 1 characters
breathing_disturbance_index
Any of:
integer
day
required

Day that the spo2 values belong to.

string
spo2_percentage
Any of:
PublicSpo2AggregatedValues

Object defining public spo2 aggregated values.

object
average
required

Average of spo2.

number
next_token
required
Any of:
string
Examplegenerated
{
"data": [
{
"id": "example",
"breathing_disturbance_index": 1,
"day": "example",
"spo2_percentage": {
"average": 1
}
}
],
"next_token": "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.

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.