Skip to content

Multiple Daily Activity Documents

GET
/v2/usercollection/daily_activity
curl --location --request GET 'https://api.ouraring.com/v2/usercollection/daily_activity?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[PublicDailyActivity]
object
data
required
Data
Array<object>
PublicDailyActivity

Object defining a daily activity that is a 24-hour period starting at 4 a.m.

object
id
required

Unique identifier of the object.

string
>= 1 characters
active_calories
required

Active calories expended in kilocalories.

integer
average_met_minutes
required

Average MET minutes.

number
class_5_min
Any of:
string
contributors
required

Object containing activity score contributors.

object
meet_daily_targets
Any of:
integer
move_every_hour
Any of:
integer
recovery_time
Any of:
integer
stay_active
Any of:
integer
training_frequency
Any of:
integer
training_volume
Any of:
integer
day
required

Day that the daily activity belong to.

string
equivalent_walking_distance
required

Equivalent walking distance of energe expenditure in meters.

integer
high_activity_met_minutes
required

The total METs of each minute classified as high activity.

integer
high_activity_time
required

The total time in seconds of each minute classified as high activity.

integer
inactivity_alerts
required

Number of inactivity alerts received.

integer
low_activity_met_minutes
required

The total METs of each minute classified as low activity.

integer
low_activity_time
required

The total time in seconds of each minute classified as low activity.

integer
medium_activity_met_minutes
required

The total METs of each minute classified as medium activity.

integer
medium_activity_time
required

The total time in seconds of each minute classified as medium activity.

integer
met
required

Sample containing METs.

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
meters_to_target
required

Meters remaining to target.

integer
non_wear_time
required

Ring non-wear time in seconds.

integer
resting_time
required

Resting time in seconds.

integer
score
Any of:
integer
sedentary_met_minutes
required

Sedentary MET minutes.

integer
sedentary_time
required

Sedentary time in seconds.

integer
steps
required

Total number of steps taken.

integer
target_calories
required

Daily activity target in kilocalories.

integer
target_meters
required

Daily activity target in meters.

integer
timestamp
required

Timestamp of the daily activity.

string
total_calories
required

Total calories expended in kilocalories.

integer
next_token
required
Any of:
string
Examplegenerated
{
"data": [
{
"id": "example",
"active_calories": 1,
"average_met_minutes": 1,
"class_5_min": "example",
"contributors": {
"meet_daily_targets": 1,
"move_every_hour": 1,
"recovery_time": 1,
"stay_active": 1,
"training_frequency": 1,
"training_volume": 1
},
"day": "example",
"equivalent_walking_distance": 1,
"high_activity_met_minutes": 1,
"high_activity_time": 1,
"inactivity_alerts": 1,
"low_activity_met_minutes": 1,
"low_activity_time": 1,
"medium_activity_met_minutes": 1,
"medium_activity_time": 1,
"met": {
"interval": 1,
"items": [
1
],
"timestamp": "example"
},
"meters_to_target": 1,
"non_wear_time": 1,
"resting_time": 1,
"score": 1,
"sedentary_met_minutes": 1,
"sedentary_time": 1,
"steps": 1,
"target_calories": 1,
"target_meters": 1,
"timestamp": "example",
"total_calories": 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.