Oura Sandbox Routes API is one of 22 APIs that Oura publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Sandbox Routes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
35 operations
across 35 paths,
and defines 72 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.
The identity and technical contract details declared by the specification.
PublicSleepTimeRecommendation
string
Possible public SleepTime recommendation.
PublicRestModeEpisode
object
Object defining a public Rest Mode episode.
2 properties
2 required
PublicMomentMood
string
Possible Moment moods.
ResilienceContributors
object
3 properties
3 required
PublicReadinessContributors
object
Object defining readiness score contributors.
9 properties
PublicSleepTimeStatus
string
Possible public SleepTime status.
PublicDailyStress
object
Daily stress.
6 properties
3 required
HTTPValidationError
object
1 property
PublicReadiness
object
Object defining readiness.
4 properties
1 required
MultiDocumentResponse_PublicSleepTime_
object
2 properties
2 required
TimeSeriesResponse_PublicHeartRateRow_
object
2 properties
1 required
PublicSleepAnalysisReason
string
Possible sleep analysis reasons.
PublicSession
object
Public model defining a recorded Session.
10 properties
6 required
MultiDocumentResponse_PublicVO2Max_
object
2 properties
2 required
MultiDocumentResponse_EnhancedTagModel_
object
2 properties
2 required
MultiDocumentResponseDict
object
2 properties
2 required
PublicDailySpO2
object
Daily SpO2 (Oxygen saturation).
5 properties
3 required
MultiDocumentResponse_PublicDailyReadiness_
object
2 properties
2 required
PublicWorkoutIntensity
string
Possible workout intensities.
PublicDailySleep
object
Public object defining daily sleep.
6 properties
5 required
PublicSleepContributors
object
Object defining sleep score contributors.
7 properties
PublicRingColor
string
Possible ring colors.
MultiDocumentResponse_PublicDailyCardiovascularAge_
object
2 properties
2 required
MultiDocumentResponse_PublicDailySleep_
object
2 properties
2 required
MultiDocumentResponse_PublicSession_
object
2 properties
2 required
MultiDocumentResponse_PublicWorkout_
object
2 properties
2 required
ValidationError
object
3 properties
3 required
PublicDailyActivity
object
Object defining a daily activity that is a 24-hour period starting at 4 a.m.
27 properties
25 required
TagModel
object
A TagModel maps to an ASSANote. An ASSANote in ExtAPIV2 is called a Tag A TagModel will be populated by data from an ASSANote The fields in the TagModel map to…
5 properties
5 required
MultiDocumentResponse_TagModel_
object
2 properties
2 required
PublicHeartRateRow
object
Heart rate sample
4 properties
4 required
MultiDocumentResponse_PublicRestModePeriod_
object
2 properties
2 required
PublicSleepAlgorithmVersion
string
Oura Sleep Staging Algorithms. v1 = original aka legacy aka OSSA 1.0, v2 = latest sleep algorithm
EnhancedTagModel
object
An EnhancedTagModel maps an ASSATag. An ASSATag in ExtAPIV2 is called a EnhancedTag An EnhancedTagModel will be populated by data from an ASSATag The fields in…
8 properties
3 required
Array_Union_float__NoneType__Bits64_
array
PublicRingBatteryLevelRow
object
Object defining a ring battery level event.
5 properties
3 required
PublicSample
object
Object defining a recorded sample.
3 properties
3 required
PublicRingHardwareType
string
Possible ring hardware types.
PublicModifiedSleepModel
object
33 properties
8 required
DailyResilienceModel
object
4 properties
4 required
PublicSleepTimeWindow
object
Object defining sleep time window
3 properties
3 required
PublicMomentType
string
Possible Moment types.
PublicHeartRateSource
string
Possible heart rate sources.
PublicDailyStressSummary
string
Possible public daily stress summary types.
Metadata
object
Object defining the metadata of a collection model instance.
2 properties
2 required
PublicSleepType
string
Possible sleep period types. 'deleted' = deleted sleep by user. 'sleep' = user confirmed sleep / nap, min 15 minutes, max 3 hours, contributes to daily scores…
PublicWorkoutSource
string
Possible workout sources.
LongTermResilienceLevel
string
Possible long term resilience level values.
MultiDocumentResponse_PublicRingConfiguration_
object
2 properties
2 required
PublicSleepTime
object
Suggested bedtime for the user.
6 properties
3 required
TimeSeriesResponse_PublicInterbeatIntervalRow_
object
2 properties
1 required
MultiDocumentResponse_PublicDailyStress_
object
2 properties
2 required
MultiDocumentResponse_PublicDailyActivity_
object
2 properties
2 required
PublicActivityContributors
object
Object defining activity score contributors.
6 properties
PublicVO2Max
object
VO2Max estimate.
5 properties
5 required
PublicWorkout
object
Public model for Workout.
11 properties
8 required
PublicInterbeatIntervalRow
object
Discrete interbeat interval
4 properties
4 required
PublicDailyCardiovascularAge
object
Daily Cardiovascular Age.
4 properties
3 required
PublicDailyReadiness
object
Public object defining daily readiness.
8 properties
5 required
TimeSeriesResponseDict
object
2 properties
1 required
MultiDocumentResponse_PublicDailySpO2_
object
2 properties
2 required
PublicRingDesign
string
Possible ring designs.
PublicRestModePeriod
object
Rest mode episode information.
7 properties
4 required
MultiDocumentResponse_DailyResilienceModel_
object
2 properties
2 required
TimeSeriesResponse_PublicRingBatteryLevelRow_
object
2 properties
1 required
PublicRingConfiguration
object
Ring configuration.
8 properties
2 required
PublicSpo2AggregatedValues
object
Object defining public spo2 aggregated values.
1 property
1 required
MultiDocumentResponse_PublicModifiedSleepModel_
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oura publishes across the network.
