Expand description
Types used as operation parameters and responses.
Modules§
- error
- Error types.
Structs§
- Array
Union Float None Type Bits64 ArrayUnionFloatNoneTypeBits64- Create
Webhook Subscription Request CreateWebhookSubscriptionRequest- Daily
Resilience Model DailyResilienceModel- Enhanced
TagModel - 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 the EnhancedTagModel map to fields in an ASSATag
- Http
Validation Error HttpValidationError- IsoDate
IsoDate- Local
Date Time LocalDateTime- Localized
Date Time LocalizedDateTime- Multi
Document Response Daily Resilience Model MultiDocumentResponseDailyResilienceModel- Multi
Document Response Enhanced TagModel MultiDocumentResponseEnhancedTagModel- Multi
Document Response Public Daily Activity MultiDocumentResponsePublicDailyActivity- Multi
Document Response Public Daily Cardiovascular Age MultiDocumentResponsePublicDailyCardiovascularAge- Multi
Document Response Public Daily Readiness MultiDocumentResponsePublicDailyReadiness- Multi
Document Response Public Daily Sleep MultiDocumentResponsePublicDailySleep- Multi
Document Response Public Daily SpO2 MultiDocumentResponsePublicDailySpO2- Multi
Document Response Public Daily Stress MultiDocumentResponsePublicDailyStress- Multi
Document Response Public Modified Sleep Model MultiDocumentResponsePublicModifiedSleepModel- Multi
Document Response Public Rest Mode Period MultiDocumentResponsePublicRestModePeriod- Multi
Document Response Public Ring Configuration MultiDocumentResponsePublicRingConfiguration- Multi
Document Response Public Session MultiDocumentResponsePublicSession- Multi
Document Response Public Sleep Time MultiDocumentResponsePublicSleepTime- Multi
Document Response Public Vo2Max MultiDocumentResponsePublicVo2Max- Multi
Document Response Public Workout MultiDocumentResponsePublicWorkout- Multi
Document Response TagModel MultiDocumentResponseTagModel- Personal
Info Response PersonalInfoResponse- Public
Activity Contributors - Object defining activity score contributors.
- Public
Daily Activity - Object defining a daily activity that is a 24-hour period starting at 4 a.m.
- Public
Daily Cardiovascular Age - Daily Cardiovascular Age.
- Public
Daily Readiness - Public object defining daily readiness.
- Public
Daily Sleep - Public object defining daily sleep.
- Public
Daily SpO2 - Daily SpO2 (Oxygen saturation).
- Public
Daily Stress - Daily stress.
- Public
Heart Rate Row - Heart rate sample
- Public
Modified Sleep Model PublicModifiedSleepModel- Public
Readiness - Object defining readiness.
- Public
Readiness Contributors - Object defining readiness score contributors.
- Public
Rest Mode Episode - Object defining a public Rest Mode episode.
- Public
Rest Mode Period - Rest mode episode information.
- Public
Ring Battery Level Row - Object defining a ring battery level event.
- Public
Ring Configuration - Ring configuration.
- Public
Sample - Object defining a recorded sample.
- Public
Session - Public model defining a recorded Session.
- Public
Sleep Contributors - Object defining sleep score contributors.
- Public
Sleep Time - Suggested bedtime for the user.
- Public
Sleep Time Window - Object defining sleep time window
- Public
Spo2 Aggregated Values - Object defining public spo2 aggregated values.
- Public
Vo2Max - VO2Max estimate.
- Public
Workout - Public model for Workout.
- Resilience
Contributors ResilienceContributors- Response
Multiple Heartrate Documents V2Usercollection Heartrate Get ResponseMultipleHeartrateDocumentsV2UsercollectionHeartrateGet- Response
Multiple Ring Battery Level Documents V2Usercollection Ring Battery Level Get ResponseMultipleRingBatteryLevelDocumentsV2UsercollectionRingBatteryLevelGet- Response
Sandbox Multiple Heartrate Documents V2Sandbox Usercollection Heartrate Get ResponseSandboxMultipleHeartrateDocumentsV2SandboxUsercollectionHeartrateGet- Response
Sandbox Multiple Ring Battery Level Documents V2Sandbox Usercollection Ring Battery Level Get ResponseSandboxMultipleRingBatteryLevelDocumentsV2SandboxUsercollectionRingBatteryLevelGet- TagModel
- 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 fields in an ASSANote
- Time
Series Response Dict TimeSeriesResponseDict- Time
Series Response Public Heart Rate Row TimeSeriesResponsePublicHeartRateRow- Time
Series Response Public Ring Battery Level Row TimeSeriesResponsePublicRingBatteryLevelRow- Update
Webhook Subscription Request UpdateWebhookSubscriptionRequest- UtcDate
Time UtcDateTime- Validation
Error ValidationError- Webhook
Subscription Model WebhookSubscriptionModel- X
- Unique identifier of the object.
Enums§
- ExtApi
V2Data Type - Data types that partners can subscribe to via ExtApiV2 webhooks.
- Location
Item LocationItem- Long
Term Resilience Level - Possible long term resilience level values.
- Public
Daily Stress Summary - Possible public daily stress summary types.
- Public
Heart Rate Source - Possible heart rate sources.
- Public
Moment Mood - Possible Moment moods.
- Public
Moment Type - Possible Moment types.
- Public
Ring Color - Possible ring colors.
- Public
Ring Design - Possible ring designs.
- Public
Ring Hardware Type - Possible ring hardware types.
- Public
Sleep Algorithm Version - Oura Sleep Staging Algorithms. v1 = original aka legacy aka OSSA 1.0, v2 = latest sleep algorithm
- Public
Sleep Analysis Reason - Possible sleep analysis reasons.
- Public
Sleep Time Recommendation - Possible public SleepTime recommendation.
- Public
Sleep Time Status - Possible public SleepTime status.
- Public
Sleep Type - Possible sleep period types. ‘deleted’ = deleted sleep by user. ‘sleep’ = user confirmed sleep / nap, min 15 minutes, max 3 hours, contributes to daily scores ‘late_nap’ = user confirmed sleep / nap, min 15 minutes, ended after sleep day change (6 pm), contributes to next days daily scores ‘long_sleep’ = sleep that is long enough (>3h) to automatically contribute to daily scores ‘rest’ = Falsely detected sleep / nap, rejected in confirm prompt by user
- Public
Workout Intensity - Possible workout intensities.
- Public
Workout Source - Possible workout sources.
- Webhook
Operation WebhookOperation