openapi: 3.1.0 info: title: Vital Lab Report Parser API description: Submit existing lab-result PDFs to be parsed and normalized into structured biomarker results. Create lab-report parser jobs and poll for job status and parsed results. version: 0.4.497 contact: name: Junction (Vital) Support url: https://docs.junction.com paths: /lab_report/v1/parser/job: post: tags: - lab_report summary: Create Lab Report Parser Job description: 'Creates a parse job, uploads the file(s) to provider, persists the job row, and starts the ParseLabReport. Returns a generated job_id.' operationId: CreateLabReportParserJob requestBody: content: multipart/form-data: schema: $ref: '#/components/schemas/CreateLabReportParserJobBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ParsingJob' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: lab_report x-fern-sdk-method-name: parser_create_job x-fern-availability: beta /lab_report/v1/parser/job/{job_id}: get: tags: - lab_report summary: Get Lab Report Parser Job description: "Retrieves the parse job status and stored result if completed.\n\nReturns:\n ParseLabResultJobResponse\ \ with job status and parsed data (if complete)" operationId: get_lab_report_parser_job_lab_report_v1_parser_job__job_id__get parameters: - name: job_id in: path required: true schema: type: string format: uuid title: Job Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ParsingJob' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: lab_report x-fern-sdk-method-name: parser_get_job x-fern-availability: beta webhooks: daily.data.activity.*: post: tags: - summary summary: Activity operationId: activitydaily_data_activity___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingActivityChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep.*: post: tags: - summary summary: Sleep operationId: sleepdaily_data_sleep___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep_cycle.*: post: tags: - summary summary: Sleep Cycle operationId: sleep_cycledaily_data_sleep_cycle___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepCycleChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workouts.*: post: tags: - summary summary: Workout operationId: workoutdaily_data_workouts___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutsChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_stream.*: post: tags: - summary summary: Workout Stream operationId: workout_streamdaily_data_workout_stream___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutStreamChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body.*: post: tags: - summary summary: Body operationId: bodydaily_data_body___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.profile.*: post: tags: - summary summary: Profile operationId: profiledaily_data_profile___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingProfileChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.meal.*: post: tags: - summary summary: Meal operationId: mealdaily_data_meal___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMealChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.menstrual_cycle.*: post: tags: - summary summary: Menstrual Cycle operationId: menstrual_cycledaily_data_menstrual_cycle___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMenstrualCycleChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.electrocardiogram.*: post: tags: - summary summary: Electrocardiogram operationId: electrocardiogramdaily_data_electrocardiogram___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.activity.created: post: tags: - summary summary: Activity Historical Pull Completed operationId: activity_historical_pull_completedhistorical_data_activity_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingActivityHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep.created: post: tags: - summary summary: Sleep Historical Pull Completed operationId: sleep_historical_pull_completedhistorical_data_sleep_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep_cycle.created: post: tags: - summary summary: Sleep Cycle Historical Pull Completed operationId: sleep_cycle_historical_pull_completedhistorical_data_sleep_cycle_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepCycleHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workouts.created: post: tags: - summary summary: Workout Historical Pull Completed operationId: workout_historical_pull_completedhistorical_data_workouts_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutsHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_stream.created: post: tags: - summary summary: Workout Stream Historical Pull Completed operationId: workout_stream_historical_pull_completedhistorical_data_workout_stream_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutStreamHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body.created: post: tags: - summary summary: Body Historical Pull Completed operationId: body_historical_pull_completedhistorical_data_body_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.profile.created: post: tags: - summary summary: Profile Historical Pull Completed operationId: profile_historical_pull_completedhistorical_data_profile_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingProfileHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.meal.created: post: tags: - summary summary: Meal Historical Pull Completed operationId: meal_historical_pull_completedhistorical_data_meal_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMealHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.menstrual_cycle.created: post: tags: - summary summary: Menstrual Cycle Historical Pull Completed operationId: menstrual_cycle_historical_pull_completedhistorical_data_menstrual_cycle_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMenstrualCycleHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.electrocardiogram.created: post: tags: - summary summary: Electrocardiogram Historical Pull Completed operationId: electrocardiogram_historical_pull_completedhistorical_data_electrocardiogram_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' continuous_query.result_table.changed: post: tags: - aggregation summary: Result Table Changed operationId: result_table_changedcontinuous_query_result_table_changed_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingContinuousQueryResultTableChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' provider.connection.created: post: tags: - link summary: Provider Connection Created operationId: provider_connection_createdprovider_connection_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingProviderConnectionCreatedEvent' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' provider.connection.error: post: tags: - link summary: Provider Connection Error operationId: provider_connection_errorprovider_connection_error_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingProviderConnectionErrorEvent' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' provider.device.*: post: tags: - summary summary: Provider Device Created operationId: provider_device_createdprovider_device___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDeviceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' labtest.order.*: post: tags: - lab-testing summary: Order operationId: orderlabtest_order___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingOrderChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' labtest.appointment.*: post: tags: - lab-testing summary: Appointment operationId: appointmentlabtest_appointment___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingAppointmentChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' labtest.result.critical: post: tags: - lab-testing summary: Critical Result operationId: critical_resultlabtest_result_critical_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCriticalResultIdentified' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' lab_report.parsing_job.created: post: tags: - lab-testing summary: Lab Report Parsing Job Created operationId: lab_report_parsing_job_createdlab_report_parsing_job_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLabReportParsingJobCreatedEvent' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' lab_report.parsing_job.updated: post: tags: - lab-testing summary: Lab Report Parsing Job Updated operationId: lab_report_parsing_job_updatedlab_report_parsing_job_updated_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLabReportParsingJobUpdatedEvent' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.calories_active.*: post: tags: - timeseries summary: Calories Active operationId: calories_activedaily_data_calories_active___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesActiveChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.calories_active.created: post: tags: - timeseries summary: Calories Active Historical Pull Completed operationId: calories_active_historical_pull_completedhistorical_data_calories_active_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesActiveHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.calories_basal.*: post: tags: - timeseries summary: Calories Basal operationId: calories_basaldaily_data_calories_basal___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesBasalChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.calories_basal.created: post: tags: - timeseries summary: Calories Basal Historical Pull Completed operationId: calories_basal_historical_pull_completedhistorical_data_calories_basal_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesBasalHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.blood_pressure.*: post: tags: - timeseries summary: Blood Pressure operationId: blood_pressuredaily_data_blood_pressure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodPressureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.blood_pressure.created: post: tags: - timeseries summary: Blood Pressure Historical Pull Completed operationId: blood_pressure_historical_pull_completedhistorical_data_blood_pressure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodPressureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.blood_oxygen.*: post: tags: - timeseries summary: Blood Oxygen operationId: blood_oxygendaily_data_blood_oxygen___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodOxygenChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.blood_oxygen.created: post: tags: - timeseries summary: Blood Oxygen Historical Pull Completed operationId: blood_oxygen_historical_pull_completedhistorical_data_blood_oxygen_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodOxygenHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.weight.*: post: tags: - timeseries summary: Weight operationId: weightdaily_data_weight___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWeightChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.weight.created: post: tags: - timeseries summary: Weight Historical Pull Completed operationId: weight_historical_pull_completedhistorical_data_weight_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWeightHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.fat.*: post: tags: - timeseries summary: Fat operationId: fatdaily_data_fat___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFatChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.fat.created: post: tags: - timeseries summary: Fat Historical Pull Completed operationId: fat_historical_pull_completedhistorical_data_fat_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFatHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_temperature.*: post: tags: - timeseries summary: Body Temperature operationId: body_temperaturedaily_data_body_temperature___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_temperature.created: post: tags: - timeseries summary: Body Temperature Historical Pull Completed operationId: body_temperature_historical_pull_completedhistorical_data_body_temperature_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_temperature_delta.*: post: tags: - timeseries summary: Body Temperature Delta operationId: body_temperature_deltadaily_data_body_temperature_delta___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_temperature_delta.created: post: tags: - timeseries summary: Body Temperature Delta Historical Pull Completed operationId: body_temperature_delta_historical_pull_completedhistorical_data_body_temperature_delta_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.caffeine.*: post: tags: - timeseries summary: Caffeine operationId: caffeinedaily_data_caffeine___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaffeineChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.caffeine.created: post: tags: - timeseries summary: Caffeine Historical Pull Completed operationId: caffeine_historical_pull_completedhistorical_data_caffeine_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaffeineHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.cholesterol.*: post: tags: - timeseries summary: Cholesterol operationId: cholesteroldaily_data_cholesterol___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCholesterolChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.cholesterol.created: post: tags: - timeseries summary: Cholesterol Historical Pull Completed operationId: cholesterol_historical_pull_completedhistorical_data_cholesterol_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCholesterolHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.distance.*: post: tags: - timeseries summary: Distance operationId: distancedaily_data_distance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDistanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.distance.created: post: tags: - timeseries summary: Distance Historical Pull Completed operationId: distance_historical_pull_completedhistorical_data_distance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDistanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.floors_climbed.*: post: tags: - timeseries summary: Floors Climbed operationId: floors_climbeddaily_data_floors_climbed___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFloorsClimbedChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.floors_climbed.created: post: tags: - timeseries summary: Floors Climbed Historical Pull Completed operationId: floors_climbed_historical_pull_completedhistorical_data_floors_climbed_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFloorsClimbedHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.glucose.*: post: tags: - timeseries summary: Glucose operationId: glucosedaily_data_glucose___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingGlucoseChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.glucose.created: post: tags: - timeseries summary: Glucose Historical Pull Completed operationId: glucose_historical_pull_completedhistorical_data_glucose_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingGlucoseHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heartrate.*: post: tags: - timeseries summary: Heartrate operationId: heartratedaily_data_heartrate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartrateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heartrate.created: post: tags: - timeseries summary: Heartrate Historical Pull Completed operationId: heartrate_historical_pull_completedhistorical_data_heartrate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartrateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.hrv.*: post: tags: - timeseries summary: Hrv operationId: hrvdaily_data_hrv___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHrvChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.hrv.created: post: tags: - timeseries summary: Hrv Historical Pull Completed operationId: hrv_historical_pull_completedhistorical_data_hrv_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHrvHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.ige.*: post: tags: - timeseries summary: Ige operationId: igedaily_data_ige___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIgeChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.ige.created: post: tags: - timeseries summary: Ige Historical Pull Completed operationId: ige_historical_pull_completedhistorical_data_ige_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIgeHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.igg.*: post: tags: - timeseries summary: Igg operationId: iggdaily_data_igg___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIggChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.igg.created: post: tags: - timeseries summary: Igg Historical Pull Completed operationId: igg_historical_pull_completedhistorical_data_igg_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIggHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.mindfulness_minutes.*: post: tags: - timeseries summary: Mindfulness Minutes operationId: mindfulness_minutesdaily_data_mindfulness_minutes___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.mindfulness_minutes.created: post: tags: - timeseries summary: Mindfulness Minutes Historical Pull Completed operationId: mindfulness_minutes_historical_pull_completedhistorical_data_mindfulness_minutes_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.respiratory_rate.*: post: tags: - timeseries summary: Respiratory Rate operationId: respiratory_ratedaily_data_respiratory_rate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingRespiratoryRateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.respiratory_rate.created: post: tags: - timeseries summary: Respiratory Rate Historical Pull Completed operationId: respiratory_rate_historical_pull_completedhistorical_data_respiratory_rate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingRespiratoryRateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.steps.*: post: tags: - timeseries summary: Steps operationId: stepsdaily_data_steps___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStepsChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.steps.created: post: tags: - timeseries summary: Steps Historical Pull Completed operationId: steps_historical_pull_completedhistorical_data_steps_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStepsHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stress_level.*: post: tags: - timeseries summary: Stress Level operationId: stress_leveldaily_data_stress_level___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStressLevelChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stress_level.created: post: tags: - timeseries summary: Stress Level Historical Pull Completed operationId: stress_level_historical_pull_completedhistorical_data_stress_level_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStressLevelHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.vo2_max.*: post: tags: - timeseries summary: Vo2 Max operationId: vo2_maxdaily_data_vo2_max___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingVo2MaxChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.vo2_max.created: post: tags: - timeseries summary: Vo2 Max Historical Pull Completed operationId: vo2_max_historical_pull_completedhistorical_data_vo2_max_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingVo2MaxHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.water.*: post: tags: - timeseries summary: Water operationId: waterdaily_data_water___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaterChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.water.created: post: tags: - timeseries summary: Water Historical Pull Completed operationId: water_historical_pull_completedhistorical_data_water_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaterHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.electrocardiogram_voltage.*: post: tags: - timeseries summary: Electrocardiogram Voltage operationId: electrocardiogram_voltagedaily_data_electrocardiogram_voltage___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.electrocardiogram_voltage.created: post: tags: - timeseries summary: Electrocardiogram Voltage Historical Pull Completed operationId: electrocardiogram_voltage_historical_pull_completedhistorical_data_electrocardiogram_voltage_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.afib_burden.*: post: tags: - timeseries summary: Afib Burden operationId: afib_burdendaily_data_afib_burden___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingAfibBurdenChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.afib_burden.created: post: tags: - timeseries summary: Afib Burden Historical Pull Completed operationId: afib_burden_historical_pull_completedhistorical_data_afib_burden_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingAfibBurdenHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heart_rate_alert.*: post: tags: - timeseries summary: Heart Rate Alert operationId: heart_rate_alertdaily_data_heart_rate_alert___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateAlertChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heart_rate_alert.created: post: tags: - timeseries summary: Heart Rate Alert Historical Pull Completed operationId: heart_rate_alert_historical_pull_completedhistorical_data_heart_rate_alert_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateAlertHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_duration.*: post: tags: - timeseries summary: Workout Duration operationId: workout_durationdaily_data_workout_duration___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDurationChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_duration.created: post: tags: - timeseries summary: Workout Duration Historical Pull Completed operationId: workout_duration_historical_pull_completedhistorical_data_workout_duration_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDurationHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.insulin_injection.*: post: tags: - timeseries summary: Insulin Injection operationId: insulin_injectiondaily_data_insulin_injection___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInsulinInjectionChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.insulin_injection.created: post: tags: - timeseries summary: Insulin Injection Historical Pull Completed operationId: insulin_injection_historical_pull_completedhistorical_data_insulin_injection_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInsulinInjectionHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.carbohydrates.*: post: tags: - timeseries summary: Carbohydrates operationId: carbohydratesdaily_data_carbohydrates___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCarbohydratesChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.carbohydrates.created: post: tags: - timeseries summary: Carbohydrates Historical Pull Completed operationId: carbohydrates_historical_pull_completedhistorical_data_carbohydrates_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCarbohydratesHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.note.*: post: tags: - timeseries summary: Note operationId: notedaily_data_note___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingNoteChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.note.created: post: tags: - timeseries summary: Note Historical Pull Completed operationId: note_historical_pull_completedhistorical_data_note_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingNoteHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stand_hour.*: post: tags: - timeseries summary: Stand Hour operationId: stand_hourdaily_data_stand_hour___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandHourChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stand_hour.created: post: tags: - timeseries summary: Stand Hour Historical Pull Completed operationId: stand_hour_historical_pull_completedhistorical_data_stand_hour_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandHourHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stand_duration.*: post: tags: - timeseries summary: Stand Duration operationId: stand_durationdaily_data_stand_duration___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandDurationChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stand_duration.created: post: tags: - timeseries summary: Stand Duration Historical Pull Completed operationId: stand_duration_historical_pull_completedhistorical_data_stand_duration_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandDurationHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep_apnea_alert.*: post: tags: - timeseries summary: Sleep Apnea Alert operationId: sleep_apnea_alertdaily_data_sleep_apnea_alert___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepApneaAlertChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep_apnea_alert.created: post: tags: - timeseries summary: Sleep Apnea Alert Historical Pull Completed operationId: sleep_apnea_alert_historical_pull_completedhistorical_data_sleep_apnea_alert_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepApneaAlertHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep_breathing_disturbance.*: post: tags: - timeseries summary: Sleep Breathing Disturbance operationId: sleep_breathing_disturbancedaily_data_sleep_breathing_disturbance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep_breathing_disturbance.created: post: tags: - timeseries summary: Sleep Breathing Disturbance Historical Pull Completed operationId: sleep_breathing_disturbance_historical_pull_completedhistorical_data_sleep_breathing_disturbance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.wheelchair_push.*: post: tags: - timeseries summary: Wheelchair Push operationId: wheelchair_pushdaily_data_wheelchair_push___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWheelchairPushChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.wheelchair_push.created: post: tags: - timeseries summary: Wheelchair Push Historical Pull Completed operationId: wheelchair_push_historical_pull_completedhistorical_data_wheelchair_push_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWheelchairPushHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.forced_expiratory_volume_1.*: post: tags: - timeseries summary: Forced Expiratory Volume 1 operationId: forced_expiratory_volume_1daily_data_forced_expiratory_volume_1___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1Changed' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.forced_expiratory_volume_1.created: post: tags: - timeseries summary: Forced Expiratory Volume 1 Historical Pull Completed operationId: forced_expiratory_volume_1_historical_pull_completedhistorical_data_forced_expiratory_volume_1_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.forced_vital_capacity.*: post: tags: - timeseries summary: Forced Vital Capacity operationId: forced_vital_capacitydaily_data_forced_vital_capacity___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedVitalCapacityChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.forced_vital_capacity.created: post: tags: - timeseries summary: Forced Vital Capacity Historical Pull Completed operationId: forced_vital_capacity_historical_pull_completedhistorical_data_forced_vital_capacity_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedVitalCapacityHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.peak_expiratory_flow_rate.*: post: tags: - timeseries summary: Peak Expiratory Flow Rate operationId: peak_expiratory_flow_ratedaily_data_peak_expiratory_flow_rate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.peak_expiratory_flow_rate.created: post: tags: - timeseries summary: Peak Expiratory Flow Rate Historical Pull Completed operationId: peak_expiratory_flow_rate_historical_pull_completedhistorical_data_peak_expiratory_flow_rate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.inhaler_usage.*: post: tags: - timeseries summary: Inhaler Usage operationId: inhaler_usagedaily_data_inhaler_usage___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInhalerUsageChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.inhaler_usage.created: post: tags: - timeseries summary: Inhaler Usage Historical Pull Completed operationId: inhaler_usage_historical_pull_completedhistorical_data_inhaler_usage_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInhalerUsageHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.fall.*: post: tags: - timeseries summary: Fall operationId: falldaily_data_fall___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFallChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.fall.created: post: tags: - timeseries summary: Fall Historical Pull Completed operationId: fall_historical_pull_completedhistorical_data_fall_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFallHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.uv_exposure.*: post: tags: - timeseries summary: Uv Exposure operationId: uv_exposuredaily_data_uv_exposure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingUvExposureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.uv_exposure.created: post: tags: - timeseries summary: Uv Exposure Historical Pull Completed operationId: uv_exposure_historical_pull_completedhistorical_data_uv_exposure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingUvExposureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.daylight_exposure.*: post: tags: - timeseries summary: Daylight Exposure operationId: daylight_exposuredaily_data_daylight_exposure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDaylightExposureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.daylight_exposure.created: post: tags: - timeseries summary: Daylight Exposure Historical Pull Completed operationId: daylight_exposure_historical_pull_completedhistorical_data_daylight_exposure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDaylightExposureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.handwashing.*: post: tags: - timeseries summary: Handwashing operationId: handwashingdaily_data_handwashing___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHandwashingChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.handwashing.created: post: tags: - timeseries summary: Handwashing Historical Pull Completed operationId: handwashing_historical_pull_completedhistorical_data_handwashing_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHandwashingHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.basal_body_temperature.*: post: tags: - timeseries summary: Basal Body Temperature operationId: basal_body_temperaturedaily_data_basal_body_temperature___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.basal_body_temperature.created: post: tags: - timeseries summary: Basal Body Temperature Historical Pull Completed operationId: basal_body_temperature_historical_pull_completedhistorical_data_basal_body_temperature_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_mass_index.*: post: tags: - timeseries summary: Body Mass Index operationId: body_mass_indexdaily_data_body_mass_index___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyMassIndexChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_mass_index.created: post: tags: - timeseries summary: Body Mass Index Historical Pull Completed operationId: body_mass_index_historical_pull_completedhistorical_data_body_mass_index_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyMassIndexHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.lean_body_mass.*: post: tags: - timeseries summary: Lean Body Mass operationId: lean_body_massdaily_data_lean_body_mass___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLeanBodyMassChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.lean_body_mass.created: post: tags: - timeseries summary: Lean Body Mass Historical Pull Completed operationId: lean_body_mass_historical_pull_completedhistorical_data_lean_body_mass_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLeanBodyMassHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.waist_circumference.*: post: tags: - timeseries summary: Waist Circumference operationId: waist_circumferencedaily_data_waist_circumference___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaistCircumferenceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.waist_circumference.created: post: tags: - timeseries summary: Waist Circumference Historical Pull Completed operationId: waist_circumference_historical_pull_completedhistorical_data_waist_circumference_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaistCircumferenceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heart_rate_recovery_one_minute.*: post: tags: - timeseries summary: Heart Rate Recovery One Minute operationId: heart_rate_recovery_one_minutedaily_data_heart_rate_recovery_one_minute___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heart_rate_recovery_one_minute.created: post: tags: - timeseries summary: Heart Rate Recovery One Minute Historical Pull Completed operationId: heart_rate_recovery_one_minute_historical_pull_completedhistorical_data_heart_rate_recovery_one_minute_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_distance.*: post: tags: - timeseries summary: Workout Distance operationId: workout_distancedaily_data_workout_distance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDistanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_distance.created: post: tags: - timeseries summary: Workout Distance Historical Pull Completed operationId: workout_distance_historical_pull_completedhistorical_data_workout_distance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDistanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_swimming_stroke.*: post: tags: - timeseries summary: Workout Swimming Stroke operationId: workout_swimming_strokedaily_data_workout_swimming_stroke___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_swimming_stroke.created: post: tags: - timeseries summary: Workout Swimming Stroke Historical Pull Completed operationId: workout_swimming_stroke_historical_pull_completedhistorical_data_workout_swimming_stroke_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: ActivityColumnExpr: properties: activity: type: string enum: - date - calories_total - calories_active - steps - distance_meter - floors_climbed - duration_active_second - intensity_sedentary_second - intensity_low_second - intensity_medium_second - intensity_high_second - heart_rate_mean - heart_rate_minimum - heart_rate_maximum - heart_rate_resting - heart_rate_mean_walking - wheelchair_use - wheelchair_push - source_type - source_provider - source_app_id - source_device_id - time_zone - time_zone_offset title: Activity description: ℹ️ This enum is non-exhaustive. type: object required: - activity title: ActivityColumnExpr AddOnOrder: properties: marker_ids: anyOf: - items: type: integer type: array - type: 'null' title: Marker Ids provider_ids: anyOf: - items: type: string type: array - type: 'null' title: Provider Ids type: object title: AddOnOrder Address: properties: first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line default: '' country: type: string title: Country zip: type: string title: Zip city: type: string title: City state: type: string title: State access_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Access Notes type: object required: - first_line - country - zip - city - state title: Address AggregateExpr: properties: arg: anyOf: - $ref: '#/components/schemas/SleepColumnExpr' - $ref: '#/components/schemas/DerivedReadinessColumnExpr' - $ref: '#/components/schemas/ActivityColumnExpr' - $ref: '#/components/schemas/WorkoutColumnExpr' - $ref: '#/components/schemas/BodyColumnExpr' - $ref: '#/components/schemas/MealColumnExpr' - $ref: '#/components/schemas/MenstrualCycleColumnExpr' - $ref: '#/components/schemas/ProfileColumnExpr' - $ref: '#/components/schemas/SleepScoreValueMacroExpr' - $ref: '#/components/schemas/ChronotypeValueMacroExpr' - $ref: '#/components/schemas/AsleepAtValueMacroExpr' - $ref: '#/components/schemas/AwakeAtValueMacroExpr' - $ref: '#/components/schemas/AwakeningsValueMacroExpr' - $ref: '#/components/schemas/UnrecognizedValueMacroExpr' - $ref: '#/components/schemas/DiscreteTimeseriesExpr' - $ref: '#/components/schemas/IntervalTimeseriesExpr' - $ref: '#/components/schemas/InsulinInjectionTimeseriesExpr' - $ref: '#/components/schemas/BloodPressureTimeseriesExpr' - $ref: '#/components/schemas/TemperatureTimeseriesExpr' - $ref: '#/components/schemas/WorkoutDurationTimeseriesExpr' - $ref: '#/components/schemas/NoteTimeseriesExpr' - $ref: '#/components/schemas/IndexColumnExpr' - $ref: '#/components/schemas/ScalarOutputSubqueryExpr' title: Arg func: type: string enum: - mean - min - max - sum - count - median - stddev - oldest - newest title: Func description: ℹ️ This enum is non-exhaustive. type: object required: - arg - func title: AggregateExpr AggregateFieldExpr: properties: func: type: string enum: - mean - min - max - sum - count - median - stddev - oldest - newest title: Func description: ℹ️ This enum is non-exhaustive. arg: anyOf: - $ref: '#/components/schemas/MCMenstrualFlowFieldExpr' - $ref: '#/components/schemas/MCCervicalMucusFieldExpr' - $ref: '#/components/schemas/MCIntermenstrualBleedingFieldExpr' - $ref: '#/components/schemas/MCContraceptiveFieldExpr' - $ref: '#/components/schemas/MCDetectedDeviationsFieldExpr' - $ref: '#/components/schemas/MCOvulationTestFieldExpr' - $ref: '#/components/schemas/MCHomePregnancyTestFieldExpr' - $ref: '#/components/schemas/MCHomeProgesteroneTestFieldExpr' - $ref: '#/components/schemas/MCSexualActivityFieldExpr' - $ref: '#/components/schemas/MCBasalBodyTemperatureFieldExpr' - $ref: '#/components/schemas/ElementFieldExpr' - type: 'null' title: Arg type: object required: - func title: AggregateFieldExpr description: 'Aggregate over unnested list elements, optionally targeting a struct field. When arg is None, the aggregate operates on the list elements directly (e.g., count-all, or mean/sum on a scalar numeric list). When arg is a FieldExpr, the struct field is extracted before aggregating.' AggregationResponse: properties: results: items: $ref: '#/components/schemas/AggregationResult' type: array title: Results type: object required: - results title: AggregationResponse AggregationResult: properties: table: additionalProperties: items: {} type: array type: object title: Table description: The result table of the query, organized in a column oriented format. type: object required: - table title: AggregationResult AllowedRadius: type: string enum: - '10' - '20' - '25' - '50' - '100' title: AllowedRadius description: ℹ️ This enum is non-exhaustive. Answer: properties: id: type: integer title: Id code: type: string title: Code value: type: string title: Value type: object required: - id - code - value title: Answer AoE: properties: questions: items: $ref: '#/components/schemas/Question' type: array title: Questions type: object required: - questions title: AoE AoEAnswer: properties: marker_id: type: integer title: Marker Id question_id: type: integer title: Question Id answer: type: string title: Answer type: object required: - marker_id - question_id - answer title: AoEAnswer AppointmentAvailabilitySlots: properties: slots: items: $ref: '#/components/schemas/DaySlots' type: array title: Slots timezone: anyOf: - type: string pattern: ^(?:(?:[A-Za-z_\-]+\/[A-Za-z_\-]+(?:\/[A-Za-z_\-]+)?)|(?:Etc\/[A-Za-z0-9+\-]+(?:\/[A-Za-z0-9]+)?|(?:CET|CST6CDT|EET|EST|EST5EDT|MET|MST|MST7MDT|PST8PDT|HST)))$ - type: 'null' title: Timezone type: object required: - slots title: AppointmentAvailabilitySlots AppointmentBookingRequest: properties: booking_key: type: string title: Booking Key appointment_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Appointment Notes async_confirmation: type: boolean title: Async Confirmation description: If true, the endpoint attempts to confirm the booking within the `sync_confirmation_timeout_millisecond` window. If confirmation is not received in time, a pending appointment is returned and booking continues asynchronously. If false (default), the endpoint waits for confirmation or returns a 500 error on failure. default: false sync_confirmation_timeout_millisecond: anyOf: - type: integer maximum: 10000 minimum: 1000 - type: 'null' title: Sync Confirmation Timeout Millisecond description: 'Maximum time (in milliseconds) to wait for booking confirmation before returning a pending appointment. Only applies when `async_confirmation` is true. Defaults to 2500ms. Range: 1000-10000ms.' async_confirmation_timeout_millisecond: anyOf: - type: integer maximum: 172800000 minimum: 60000 - type: 'null' title: Async Confirmation Timeout Millisecond description: 'Maximum time (in milliseconds) to attempt asynchronous booking before cancelling the pending appointment. Only applies when `async_confirmation` is true. Defaults to 15 minutes. Range: 60000-172800000ms.' type: object required: - booking_key title: AppointmentBookingRequest AppointmentEventStatus: type: string enum: - pending - reserved - scheduled - completed - cancelled - in_progress title: AppointmentEventStatus description: ℹ️ This enum is non-exhaustive. AppointmentLocation: properties: location: $ref: '#/components/schemas/LngLat' distance: anyOf: - type: integer - type: 'null' title: Distance address: $ref: '#/components/schemas/USAddress' code: type: string title: Code name: type: string title: Name iana_timezone: anyOf: - type: string pattern: ^(?:(?:[A-Za-z_\-]+\/[A-Za-z_\-]+(?:\/[A-Za-z_\-]+)?)|(?:Etc\/[A-Za-z0-9+\-]+(?:\/[A-Za-z0-9]+)?|(?:CET|CST6CDT|EET|EST|EST5EDT|MET|MST|MST7MDT|PST8PDT|HST)))$ - type: 'null' title: Iana Timezone type: object required: - location - address - code - name title: AppointmentLocation AppointmentPSCLabs: type: string enum: - quest - sonora_quest title: AppointmentPSCLabs description: ℹ️ This enum is non-exhaustive. AppointmentProvider: type: string enum: - getlabs - phlebfinders - quest - sonora_quest title: AppointmentProvider description: ℹ️ This enum is non-exhaustive. AppointmentRescheduleRequest: properties: booking_key: type: string title: Booking Key appointment_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Appointment Notes type: object required: - booking_key title: AppointmentRescheduleRequest AppointmentServiceType: type: string enum: - appointment-ready - appointment-request title: AppointmentServiceType description: ℹ️ This enum is non-exhaustive. AppointmentStatus: type: string enum: - confirmed - pending - reserved - in_progress - completed - cancelled title: AppointmentStatus description: ℹ️ This enum is non-exhaustive. AppointmentType: type: string enum: - phlebotomy - patient_service_center title: AppointmentType description: ℹ️ This enum is non-exhaustive. AreaInfo: properties: zip_code: type: string pattern: ^\d{5}(-\d{4})?$ title: Zip Code phlebotomy: $ref: '#/components/schemas/PhlebotomyAreaInfo' central_labs: additionalProperties: $ref: '#/components/schemas/PSCAreaInfo' propertyNames: $ref: '#/components/schemas/ClientFacingLabs' type: object title: Central Labs type: object required: - zip_code - phlebotomy - central_labs title: AreaInfo AsleepAtValueMacroExpr: properties: value_macro: type: string const: asleep_at title: Value Macro version: type: string const: automatic title: Version default: automatic type: object required: - value_macro title: AsleepAtValueMacroExpr AttemptStatus: type: string enum: - success - failure title: AttemptStatus description: ℹ️ This enum is non-exhaustive. Availability: type: string enum: - available - unavailable title: Availability description: ℹ️ This enum is non-exhaustive. AwakeAtValueMacroExpr: properties: value_macro: type: string const: awake_at title: Value Macro version: type: string const: automatic title: Version default: automatic type: object required: - value_macro title: AwakeAtValueMacroExpr AwakeningsValueMacroExpr: properties: value_macro: type: string const: awakenings title: Value Macro version: type: string const: automatic title: Version default: automatic type: object required: - value_macro title: AwakeningsValueMacroExpr BasalBodyTemperatureEntry: properties: date: type: string format: date title: Date value: type: number title: Value type: object required: - date - value title: BasalBodyTemperatureEntry Billing: type: string enum: - client_bill - commercial_insurance - patient_bill_passthrough - patient_bill title: Billing description: ℹ️ This enum is non-exhaustive. BiomarkerResult: properties: name: type: string title: Name slug: type: string title: Slug default: '' value: anyOf: - type: number - type: 'null' title: Value description: 'Deprecated: Use ''result'' (string) and `type` (enum) instead. ' deprecated: true x-fern-ignore: true result: type: string title: Result type: $ref: '#/components/schemas/ResultType' description: ℹ️ This enum is non-exhaustive. unit: anyOf: - type: string - type: 'null' title: Unit timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp notes: anyOf: - type: string - type: 'null' title: Notes reference_range: anyOf: - type: string - type: 'null' title: Reference Range min_range_value: anyOf: - type: number - type: 'null' title: Min Range Value max_range_value: anyOf: - type: number - type: 'null' title: Max Range Value is_above_max_range: anyOf: - type: boolean - type: 'null' title: Is Above Max Range is_below_min_range: anyOf: - type: boolean - type: 'null' title: Is Below Min Range interpretation: type: string title: Interpretation default: normal loinc: anyOf: - type: string - type: 'null' title: Loinc loinc_slug: anyOf: - type: string - type: 'null' title: Loinc Slug provider_id: anyOf: - type: string - type: 'null' title: Provider Id source_markers: anyOf: - items: $ref: '#/components/schemas/ParentBiomarkerData' type: array - type: 'null' title: Source Markers performing_laboratory: anyOf: - type: string - type: 'null' title: Performing Laboratory source_sample_id: anyOf: - type: string - type: 'null' title: Source Sample Id type: object required: - name - result - type title: BiomarkerResult description: Represent the schema for an individual biomarker result. example: interpretation: normal is_above_max_range: false is_below_min_range: false loinc: 742-7 loinc_slug: monocytes-auto-bld-vol max_range_value: 0.9 min_range_value: 0.1 name: Monocytes(Absolute) notes: Final result: '0.4' slug: monocytes-absolute timestamp: '2023-11-01T08:28:00+00:00' type: numeric unit: x10E3/uL value: 0.4 BloodPressureTimeseriesExpr: properties: timeseries: type: string const: blood_pressure title: Timeseries field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - systolic - diastolic title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: BloodPressureTimeseriesExpr BodyColumnExpr: properties: body: type: string enum: - measured_at - weight_kilogram - fat_mass_percentage - water_percentage - muscle_mass_percentage - visceral_fat_index - bone_mass_percentage - body_mass_index - lean_body_mass_kilogram - waist_circumference_centimeter - source_type - source_provider - source_app_id - source_device_id - time_zone title: Body description: ℹ️ This enum is non-exhaustive. type: object required: - body title: BodyColumnExpr BulkExportConnectionsBody: properties: user_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: User Ids provider: $ref: '#/components/schemas/OAuthProviders' description: ℹ️ This enum is non-exhaustive. next_token: anyOf: - type: string - type: 'null' title: Next Token type: object required: - provider title: BulkExportConnectionsBody BulkExportConnectionsResponse: properties: data: items: $ref: '#/components/schemas/ConnectionRecipe' type: array title: Data next_token: anyOf: - type: string - type: 'null' title: Next Token type: object required: - data - next_token title: BulkExportConnectionsResponse BulkImportConnectionsBody: properties: provider: $ref: '#/components/schemas/OAuthProviders' description: ℹ️ This enum is non-exhaustive. connections: items: $ref: '#/components/schemas/ConnectionRecipe' type: array title: Connections wait_for_completion: type: boolean title: Wait For Completion description: ' Whether or not the endpoint should wait for the Bulk Op to complete before responding. When `wait_for_completion` is enabled, the endpoint may respond 200 OK if the Bulk Op takes less than 20 seconds to complete. Otherwise, the endpoint always responds with 202 Created once the submitted data have been enqueued successfully. You can use the [List Bulk Ops](https://docs.tryvital.io/api-reference/link/list-bulk-ops) endpoint to inspect the progress of the Bulk Op. ' default: false type: object required: - provider - connections title: BulkImportConnectionsBody BulkImportConnectionsResponse: properties: user_ids_imported: items: type: string format: uuid type: array title: User Ids Imported user_ids_failed: items: type: string format: uuid type: array title: User Ids Failed type: object required: - user_ids_imported - user_ids_failed title: BulkImportConnectionsResponse BulkOp: properties: type: type: string enum: - link_bulk_import - link_bulk_historical_trigger title: Type description: ℹ️ This enum is non-exhaustive. status: type: string enum: - in_progress - success - failure - aborted title: Status description: ℹ️ This enum is non-exhaustive. provider: $ref: '#/components/schemas/Providers' description: ℹ️ This enum is non-exhaustive. pending: type: integer title: Pending processed: type: integer title: Processed started_at: type: string format: date-time title: Started At ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At type: object required: - type - status - provider - pending - processed - started_at - ended_at title: BulkOp BulkOpsResponse: properties: data: items: $ref: '#/components/schemas/BulkOp' type: array title: Data next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor type: object required: - data - next_cursor title: BulkOpsResponse BulkPauseConnectionsBody: properties: user_ids: items: type: string format: uuid type: array title: User Ids provider: $ref: '#/components/schemas/OAuthProviders' description: ℹ️ This enum is non-exhaustive. type: object required: - user_ids - provider title: BulkPauseConnectionsBody BulkTriggerHistoricalPullBody: properties: user_ids: items: type: string format: uuid type: array title: User Ids provider: $ref: '#/components/schemas/OAuthProviders' description: ℹ️ This enum is non-exhaustive. wait_for_completion: type: boolean title: Wait For Completion description: ' Whether or not the endpoint should wait for the Bulk Op to complete before responding. When `wait_for_completion` is enabled, the endpoint may respond 200 OK if the Bulk Op takes less than 20 seconds to complete. Otherwise, the endpoint always responds with 202 Created once the submitted data have been enqueued successfully. You can use the [List Bulk Ops](https://docs.tryvital.io/api-reference/link/list-bulk-ops) endpoint to inspect the progress of the Bulk Op. ' default: false type: object required: - user_ids - provider title: BulkTriggerHistoricalPullBody CanonicalCandidate: properties: loinc_set_hash: type: string title: Loinc Set Hash display_name: type: string title: Display Name aliases: items: type: string type: array title: Aliases loinc_codes: items: type: string type: array title: Loinc Codes provider_ids: items: type: string type: array title: Provider Ids loinc_components: items: type: string type: array title: Loinc Components loinc_groups: items: type: string type: array title: Loinc Groups cpt_codes: items: type: string type: array title: Cpt Codes popularity_score: type: number title: Popularity Score confidence: type: number title: Confidence type: object required: - loinc_set_hash - display_name - popularity_score - confidence title: CanonicalCandidate CervicalMucusEntry: properties: date: type: string format: date title: Date quality: type: string enum: - dry - sticky - creamy - watery - egg_white title: Quality description: ℹ️ This enum is non-exhaustive. type: object required: - date - quality title: CervicalMucusEntry ChronotypeValueMacroExpr: properties: value_macro: type: string const: chronotype title: Value Macro version: type: string const: automatic title: Version default: automatic type: object required: - value_macro title: ChronotypeValueMacroExpr ClientActivityResponse: properties: activity: items: $ref: '#/components/schemas/ClientFacingActivity' type: array title: Activity type: object required: - activity title: Daily Activity example: activity: - calendar_date: '2023-03-22' calories_active: 2000 calories_total: 100 created_at: '2023-02-27T20:31:24+00:00' daily_movement: 200 date: '2023-03-22T00:00:00+00:00' floors_climbed: 10 heart_rate: avg_bpm: 80 avg_walking_bpm: 70 max_bpm: 100 min_bpm: 60 resting_bpm: 60 high: 6000 id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 low: 6400 medium: 6400 source: device_id: 550e8400-e29b-41d4-a716-446655440000 logo: https://logo_url.com name: Oura slug: oura steps: 10000 time_zone: Europe/London timezone_offset: 3600 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientBodyResponse: properties: body: items: $ref: '#/components/schemas/ClientFacingBody' type: array title: Body type: object required: - body title: ClientBodyResponse example: body: - body_mass_index: 22.3 bone_mass_percentage: 4.3 calendar_date: '2023-02-27' created_at: '2023-02-27T20:31:24+00:00' date: '2023-02-27T12:31:24+00:00' fat: 30 height: 183 id: 8be1306e-01fc-46b1-b5d1-a9e39052db09 lean_body_mass_kilogram: 40.1 muscle_mass_percentage: 40.2 source: device_id: 550e8400-e29b-41d4-a716-446655440000 logo: https://logo_url.com name: Withings slug: withings updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 visceral_fat_index: 4.5 waist_circumference_centimeter: 86.36 water_percentage: 55.4 weight: 80 ClientFacingAFibBurdenSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: '%' title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingAFibBurdenSample example: end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' unit: '%' value: 3 ClientFacingActivity: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. date: type: string format: date-time title: Date description: Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date. deprecated: true calendar_date: type: string format: date title: Calendar Date description: Date of the summary in the YYYY-mm-dd format. calories_total: anyOf: - type: number - type: 'null' title: Calories Total description: Total energy consumption during the day including Basal Metabolic Rate in kilocalories::kilocalories calories_active: anyOf: - type: number - type: 'null' title: Calories Active description: Energy consumption caused by the physical activity of the day in kilocalories::kilocalories steps: anyOf: - type: integer - type: 'null' title: Steps description: Total number of steps registered during the day::steps daily_movement: anyOf: - type: number - type: 'null' title: Daily Movement description: Deprecated. Daily physical activity as equal meters i.e. amount of walking needed to get the same amount of activity::meters deprecated: true distance: anyOf: - type: number - type: 'null' title: Distance description: Distance traveled during activities throughout the day::meters low: anyOf: - type: number - type: 'null' title: Low description: Number of minutes during the day with low intensity activity (e.g. household work)::minutes medium: anyOf: - type: number - type: 'null' title: Medium description: Number of minutes during the day with medium intensity activity (e.g. walking)::minutes high: anyOf: - type: number - type: 'null' title: High description: Number of minutes during the day with high intensity activity (e.g. running)::minutes source: $ref: '#/components/schemas/ClientFacingSource' description: Source the data has come from. floors_climbed: anyOf: - type: integer - type: 'null' title: Floors Climbed description: Number of floors climbed by the user::count time_zone: anyOf: - type: string - type: 'null' title: Time Zone description: 'The IANA time zone identifier. Example: ''Europe/London''.' timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds heart_rate: anyOf: - $ref: '#/components/schemas/ClientFacingHeartRate' - type: 'null' description: Heart rate daily summary. wheelchair_use: anyOf: - type: boolean const: true - type: 'null' title: Wheelchair Use wheelchair_push: anyOf: - type: integer - type: 'null' title: Wheelchair Push created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - user_id - date - calendar_date - source - created_at - updated_at title: Daily Activity example: calendar_date: '2023-03-22' calories_active: 2000 calories_total: 100 created_at: '2023-02-27T20:31:24+00:00' daily_movement: 200 date: '2023-03-22T00:00:00+00:00' floors_climbed: 10 heart_rate: avg_bpm: 80 avg_walking_bpm: 70 max_bpm: 100 min_bpm: 60 resting_bpm: 60 high: 6000 id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 low: 6400 medium: 6400 source: device_id: 550e8400-e29b-41d4-a716-446655440000 logo: https://logo_url.com name: Oura slug: oura steps: 10000 time_zone: Europe/London timezone_offset: 3600 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientFacingApiKey: properties: label: type: string title: Label value: type: string title: Value team_id: anyOf: - type: string format: uuid - type: 'null' title: Team Id id: type: string format: uuid title: Id created_at: type: string format: date-time title: Created At deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At type: object required: - label - value - id - created_at title: ClientFacingApiKey ClientFacingAppointment: properties: id: type: string format: uuid4 title: Id user_id: type: string format: uuid4 title: User Id order_id: type: string format: uuid4 title: Order Id order_transaction_id: anyOf: - type: string format: uuid4 - type: 'null' title: Order Transaction Id address: $ref: '#/components/schemas/USAddress' location: $ref: '#/components/schemas/LngLat' start_at: anyOf: - type: string format: date-time - type: 'null' title: Start At description: Time is in UTC end_at: anyOf: - type: string format: date-time - type: 'null' title: End At description: Time is in UTC iana_timezone: anyOf: - type: string pattern: ^(?:(?:[A-Za-z_\-]+\/[A-Za-z_\-]+(?:\/[A-Za-z_\-]+)?)|(?:Etc\/[A-Za-z0-9+\-]+(?:\/[A-Za-z0-9]+)?|(?:CET|CST6CDT|EET|EST|EST5EDT|MET|MST|MST7MDT|PST8PDT|HST)))$ - type: 'null' title: Iana Timezone type: $ref: '#/components/schemas/AppointmentType' description: ℹ️ This enum is non-exhaustive. provider: $ref: '#/components/schemas/AppointmentProvider' description: ℹ️ This enum is non-exhaustive. status: $ref: '#/components/schemas/AppointmentStatus' description: ℹ️ This enum is non-exhaustive. provider_id: type: string title: Provider Id external_id: anyOf: - type: string - type: 'null' title: External Id can_reschedule: type: boolean title: Can Reschedule appointment_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Appointment Notes event_status: $ref: '#/components/schemas/AppointmentEventStatus' description: ℹ️ This enum is non-exhaustive. event_data: anyOf: - additionalProperties: true type: object - type: 'null' title: Event Data events: items: $ref: '#/components/schemas/ClientFacingAppointmentEvent' type: array title: Events type: object required: - id - user_id - order_id - address - location - start_at - end_at - type - provider - status - provider_id - can_reschedule - event_status - events title: ClientFacingAppointment example: address: access_notes: 'Gate code #1234, use side entrance' city: San Francisco country: United States first_line: 123 Main St. second_line: Apt. 208 state: CA zip_code: '91189' appointment_notes: Please bring photo ID can_reschedule: true end_at: '2022-01-01T00:00:00' event_data: description: Metadata field containing provider specific data, like cancellation reason or origin event_status: scheduled events: - created_at: '2022-01-01T00:00:00Z' status: scheduled - created_at: '2022-01-02T00:00:00Z' status: completed external_id: ext-123 iana_timezone: America/New_York id: 1614a22c-4322-43a0-96bc-8ff01e5401c8 location: lat: 37.7749295 lng: -122.4194155 order_id: 6b6b38ef-d312-48b4-95d4-731fc2ce7a6f order_transaction_id: cc089173-7db8-428e-a233-c58472226917 provider: getlabs provider_id: '123' start_at: '2022-01-01T00:00:00' status: confirmed type: phlebotomy user_id: 61fac3ce-a2c9-4218-b404-941ca948776f ClientFacingAppointmentCancellationReason: properties: id: type: string format: uuid4 title: Id name: type: string title: Name is_refundable: type: boolean title: Is Refundable type: object required: - id - name - is_refundable title: ClientFacingAppointmentCancellationReason example: id: 04e00ffd-f053-4732-9be8-72913ea1981d is_refundable: true name: I'm feeling sick ClientFacingAppointmentEvent: properties: created_at: type: string format: date-time title: Created At status: $ref: '#/components/schemas/AppointmentEventStatus' description: ℹ️ This enum is non-exhaustive. data: anyOf: - additionalProperties: true type: object - type: 'null' title: Data type: object required: - created_at - status title: ClientFacingAppointmentEvent ClientFacingAtHomePhlebotomyOrder: properties: id: type: string format: uuid title: Id description: The Vital at-home phlebotomy Order ID appointment_id: anyOf: - type: string format: uuid - type: 'null' title: Appointment Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - created_at - updated_at title: ClientFacingAtHomePhlebotomyOrder description: 'Schema for a at-home-phlebotomy test order in the client facing API. To be used as part of a ClientFacingOrder.' example: appointment_id: 10d7a598-5a7d-4743-9045-6038c73eeace created_at: '2020-01-01T00:00:00Z' id: 81d0f268-303b-486a-b8c9-1d2e4466e50b updated_at: '2020-01-01T00:00:00Z' ClientFacingAtHomePhlebotomyOrderDetails: properties: type: type: string const: at_home_phlebotomy title: Type data: anyOf: - $ref: '#/components/schemas/ClientFacingAtHomePhlebotomyOrder' - type: 'null' type: object required: - type title: ClientFacingAtHomePhlebotomyOrderDetails ClientFacingBasalBodyTemperatureSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: °C title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingBasalBodyTemperatureSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: °C value: 36.7 ClientFacingBloodOxygenTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in percentage (spo2). timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - unit - timestamp - value title: ClientFacingBloodOxygenTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 98 ClientFacingBloodPressureTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: The unit of the value. We use SI units where possible, e.g. mmol/L for glucose/cholesterol, bpm for heart rate, etc. grouping: $ref: '#/components/schemas/_ClientFacingSampleGroupingKeys' default: - unknown - null - null - null timestamp: type: string format: date-time title: Timestamp systolic: type: number title: Systolic diastolic: type: number title: Diastolic type: object required: - unit - timestamp - systolic - diastolic title: ClientFacingBloodPressureTimeseries example: diastolic: 75 systolic: 125 timestamp: '2026-05-20T13:43:41+00:00' unit: mmHg ClientFacingBody: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. date: type: string format: date-time title: Date description: Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date. deprecated: true calendar_date: type: string format: date title: Calendar Date description: Date of the summary in the YYYY-mm-dd format. weight: anyOf: - type: number - type: 'null' title: Weight description: Weight in kg::kg fat: anyOf: - type: number - type: 'null' title: Fat description: Total body fat percentage::perc water_percentage: anyOf: - type: number - type: 'null' title: Water Percentage description: Water percentage in the body::perc muscle_mass_percentage: anyOf: - type: number - type: 'null' title: Muscle Mass Percentage description: Muscle mass percentage in the body::perc visceral_fat_index: anyOf: - type: number - type: 'null' title: Visceral Fat Index description: Visceral fat index::scalar bone_mass_percentage: anyOf: - type: number - type: 'null' title: Bone Mass Percentage description: Bone mass percentage in the body::perc body_mass_index: anyOf: - type: number - type: 'null' title: Body Mass Index lean_body_mass_kilogram: anyOf: - type: number - type: 'null' title: Lean Body Mass Kilogram waist_circumference_centimeter: anyOf: - type: number - type: 'null' title: Waist Circumference Centimeter source: $ref: '#/components/schemas/ClientFacingSource' created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - user_id - date - calendar_date - source - created_at - updated_at title: ClientFacingBody example: body_mass_index: 22.3 bone_mass_percentage: 4.3 calendar_date: '2023-02-27' created_at: '2023-02-27T20:31:24+00:00' date: '2023-02-27T12:31:24+00:00' fat: 30 height: 183 id: 8be1306e-01fc-46b1-b5d1-a9e39052db09 lean_body_mass_kilogram: 40.1 muscle_mass_percentage: 40.2 source: device_id: 550e8400-e29b-41d4-a716-446655440000 logo: https://logo_url.com name: Withings slug: withings updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 visceral_fat_index: 4.5 waist_circumference_centimeter: 86.36 water_percentage: 55.4 weight: 80 ClientFacingBodyFatTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in percentage (0-100). timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - unit - timestamp - value title: ClientFacingBodyFatTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 50 ClientFacingBodyMassIndexSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: index title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingBodyMassIndexSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: index value: 21 ClientFacingBodyTemperatureDeltaSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: °C title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. sensor_location: anyOf: - type: string enum: - armpit - body - ear - finger - gastrointestinal - mouth - rectum - toe - eardrum - temporal_artery - forehead - wrist - type: 'null' title: Sensor Location description: Location of the temperature sensor. ℹ️ This enum is non-exhaustive. type: object required: - unit - timestamp - start - end - value - sensor_location title: ClientFacingBodyTemperatureDeltaSample example: end: '2023-02-13T14:57:24+00:00' sensor_location: wrist start: '2023-02-13T14:30:52+00:00' unit: °C value: -1 ClientFacingBodyTemperatureSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: °C title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. sensor_location: anyOf: - type: string enum: - armpit - body - ear - finger - gastrointestinal - mouth - rectum - toe - eardrum - temporal_artery - forehead - wrist - type: 'null' title: Sensor Location description: Location of the temperature sensor. ℹ️ This enum is non-exhaustive. type: object required: - unit - timestamp - start - end - value - sensor_location title: ClientFacingBodyTemperatureSample example: end: '2023-02-13T14:30:52+00:00' sensor_location: eardrum start: '2023-02-13T14:30:52+00:00' unit: °C value: 65 ClientFacingBodyWeightTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in kilograms (kg). timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - unit - timestamp - value title: ClientFacingBodyWeightTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: kg value: 65 ClientFacingCaffeineTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in grams. timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: Quantity of caffeine consumed during the time period. type: object required: - unit - timestamp - start - end - value title: ClientFacingCaffeineTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: g value: 42 ClientFacingCaloriesActiveTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: kcal title: Unit description: Measured in kilocalories (kcal) timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: Energy consumption caused by the physical activity at the time or interval::kilocalories type: object required: - unit - timestamp - start - end - value title: ClientFacingCaloriesActiveTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: kcal value: 184 ClientFacingCaloriesBasalTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: kcal title: Unit description: Measured in kilocalories (kcal) timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: Basal Metabolic Rate at the time or interval::kilocalories type: object required: - unit - timestamp - value title: ClientFacingCaloriesBasalTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: kcal value: 22.8 ClientFacingCarbohydratesSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in grams. timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingCarbohydratesSample example: end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' unit: g value: 30 ClientFacingCholesterolTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string title: Type description: The reading type of the measurement. unit: type: string title: Unit description: Measured in mmol/L. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - type - unit - timestamp - value title: ClientFacingCholesterolTimeseries examples: - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/ldl unit: mmol/L value: 0.6 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/hdl unit: mmol/L value: 0.2 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/total unit: mmol/L value: 0.7 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/triglycerides unit: mmol/L value: 0.7 ClientFacingConnectionErrorDetails: properties: error_type: type: string enum: - token_refresh_failed - webhook_registration_failed - user_not_found - deregistered_per_provider - required_scopes_not_granted - provider_credential_error - provider_password_expired - unknown title: Error Type description: ℹ️ This enum is non-exhaustive. error_message: type: string title: Error Message errored_at: type: string format: date-time title: Errored At type: object required: - error_type - error_message - errored_at title: ConnectionErrorDetails ClientFacingCriticalResult: properties: order_id: type: string format: uuid title: Order Id description: The Vital Order ID sample_id: type: string title: Sample Id description: Sample ID status: type: string title: Status description: The current results status, can be either (final, partial). interpretation: type: string title: Interpretation description: The results interpretation, can be one of (normal, abnormal, critical). team_id: type: string format: uuid title: Team Id description: Your team id. user_id: type: string format: uuid title: User Id created_at: type: string format: date-time title: Created At description: When the result was first fetched from a laboratory. updated_at: type: string format: date-time title: Updated At description: When the result was last fetched from a laboratory. type: object required: - order_id - sample_id - status - interpretation - team_id - user_id - created_at - updated_at title: ClientFacingCriticalResult example: created_at: '2020-01-01T00:00:00Z' interpretation: normal order_id: 20e2a5ba-0ea2-4c31-bef7-7a839cc6af5a sample_id: '123456789' status: final team_id: 45d73ffc-ce71-48f3-bf01-54ec2b346e93 updated_at: '2020-01-01T00:00:00Z' user_id: 0b8a38fa-bb73-4801-a401-ab0d1bb728b8 ClientFacingDaylightExposureSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: min title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingDaylightExposureSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: min value: 45 ClientFacingDevice: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id provider: type: string title: Provider source_type: type: string enum: - unknown - phone - watch - app - multiple_sources - fingerprick - cuff - manual_scan - automatic - insulin_pump - scale - chest_strap - ring - lab - exercise_machine - earphone title: Source Type description: ℹ️ This enum is non-exhaustive. app_id: anyOf: - type: string - type: 'null' title: App Id device_manufacturer: anyOf: - type: string - type: 'null' title: Device Manufacturer device_model: anyOf: - type: string - type: 'null' title: Device Model device_version: anyOf: - type: string - type: 'null' title: Device Version device_id: anyOf: - type: string - type: 'null' title: Device Id type: object required: - id - user_id - provider - source_type title: Device Data example: device_id: F-31-A4C138BB9EF5 device_manufacturer: Fitbit device_model: Aria Air device_version: '1.0' id: 00000000-0000-0000-0000-000000000000 provider: fitbit source_type: scale user_id: 00000000-0000-0000-0000-000000000000 ClientFacingDiagnosisInformation: properties: diagnosis_code: type: string title: Diagnosis Code description: Diagnosis code for insurance information. description: type: string title: Description description: Diagnosis description insurance information. is_secondary: type: boolean title: Is Secondary default: false type: object required: - diagnosis_code - description title: ClientFacingDiagnosisInformation ClientFacingDistanceTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: m title: Unit description: Measured in meters (m) timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: Distance traveled during activities at the time or interval::steps type: object required: - unit - timestamp - start - end - value title: ClientFacingDistanceTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: m value: 5.6 ClientFacingElectrocardiogram: properties: id: type: string format: uuid title: Id session_start: type: string format: date-time title: Session Start session_end: type: string format: date-time title: Session End voltage_sample_count: type: integer title: Voltage Sample Count heart_rate_mean: anyOf: - type: integer - type: 'null' title: Heart Rate Mean sampling_frequency_hz: anyOf: - type: number - type: 'null' title: Sampling Frequency Hz classification: anyOf: - type: string enum: - sinus_rhythm - atrial_fibrillation - inconclusive - type: 'null' title: Classification description: ℹ️ This enum is non-exhaustive. inconclusive_cause: anyOf: - type: string enum: - high_heart_rate - low_heart_rate - poor_reading - type: 'null' title: Inconclusive Cause description: ℹ️ This enum is non-exhaustive. algorithm_version: anyOf: - type: string - type: 'null' title: Algorithm Version time_zone: anyOf: - type: string - type: 'null' title: Time Zone source_provider: anyOf: - $ref: '#/components/schemas/Providers' - $ref: '#/components/schemas/Labs' title: Source Provider description: ℹ️ This enum is non-exhaustive. source_type: type: string enum: - unknown - phone - watch - app - multiple_sources - fingerprick - cuff - manual_scan - automatic - insulin_pump - scale - chest_strap - ring - lab - exercise_machine - earphone title: Source Type description: ℹ️ This enum is non-exhaustive. source_app_id: anyOf: - type: string - type: 'null' title: Source App Id source_device_model: anyOf: - type: string - type: 'null' title: Source Device Model source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At user_id: type: string format: uuid title: User Id source: $ref: '#/components/schemas/ClientFacingSource' type: object required: - id - session_start - session_end - voltage_sample_count - source_provider - source_type - user_id - source - created_at - updated_at title: Electrocardiogram example: classification: sinus_rhythm created_at: '2023-02-27T20:31:24+00:00' heart_rate_mean: 73 id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b sampling_frequency_hz: 505 session_end: '2022-01-01T08:00:00' session_start: '2022-01-01T00:00:00' source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: apple_health_kit type: watch source_provider: oura source_type: ring time_zone: America/Los_Angeles updated_at: '2023-02-28T01:22:38+00:00' user_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b voltage_sample_count: 1600 ClientFacingElectrocardiogramResponse: properties: electrocardiogram: items: $ref: '#/components/schemas/ClientFacingElectrocardiogram' type: array title: Electrocardiogram type: object required: - electrocardiogram title: Electrocardiogram Data example: electrocardiogram: - classification: sinus_rhythm created_at: '2023-02-27T20:31:24+00:00' heart_rate_mean: 73 id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b sampling_frequency_hz: 505 session_end: '2022-01-01T08:00:00' session_start: '2022-01-01T00:00:00' source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: apple_health_kit type: watch source_provider: oura source_type: ring time_zone: America/Los_Angeles updated_at: '2023-02-28T01:22:38+00:00' user_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b voltage_sample_count: 1600 ClientFacingElectrocardiogramVoltageTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string title: Type description: The lead of the measurement. unit: type: string title: Unit description: Measured in mV. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - type - unit - timestamp - value title: ClientFacingElectrocardiogramVoltageTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' type: lead_1 unit: mV value: -373 ClientFacingFallSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingFallSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 3 ClientFacingFloorsClimbedTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit description: Measured in counts timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: Number of floors climbed at the time or interval::count type: object required: - unit - timestamp - value title: ClientFacingFloorsClimbedTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: count value: 2 ClientFacingFood: properties: energy: anyOf: - $ref: '#/components/schemas/Energy' - type: 'null' macros: anyOf: - $ref: '#/components/schemas/Macros' - type: 'null' micros: anyOf: - $ref: '#/components/schemas/Micros' - type: 'null' type: object title: ClientFacingFood ClientFacingForcedExpiratoryVolume1Sample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: L title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingForcedExpiratoryVolume1Sample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L value: 3.5 ClientFacingForcedVitalCapacitySample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: L title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingForcedVitalCapacitySample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L value: 4.2 ClientFacingGlucoseTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in mmol/L. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - unit - timestamp - value title: ClientFacingGlucoseTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' type: automatic | manual_scan unit: mmol/L value: 0.5 ClientFacingHRVTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in rmssd. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: HRV calculated using rmssd during sleep type: object required: - unit - timestamp - value title: ClientFacingHRVTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: rmssd value: 48 ClientFacingHandwashingSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingHandwashingSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 ClientFacingHeartRate: properties: avg_bpm: anyOf: - type: number - type: 'null' title: Avg Bpm description: Average heart rate::bpm min_bpm: anyOf: - type: number - type: 'null' title: Min Bpm description: Minimum heart rate::bpm max_bpm: anyOf: - type: number - type: 'null' title: Max Bpm description: Maximum heart rate::bpm resting_bpm: anyOf: - type: number - type: 'null' title: Resting Bpm description: Resting heart rate::bpm avg_walking_bpm: anyOf: - type: number - type: 'null' title: Avg Walking Bpm type: object title: Heart Rate example: avg_bpm: 80 avg_walking_bpm: 70 max_bpm: 100 min_bpm: 60 resting_bpm: 60 ClientFacingHeartRateAlertSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string enum: - low_heart_rate - high_heart_rate - irregular_rhythm title: Type description: The type of heart rate alert. ℹ️ This enum is non-exhaustive. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: integer const: 1 title: Value type: object required: - type - unit - timestamp - start - end - value title: ClientFacingHeartRateAlertSample example: end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' type: irregular_rhythm unit: count value: 1 ClientFacingHeartRateRecoveryOneMinuteSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingHeartRateRecoveryOneMinuteSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 37 ClientFacingHeartRateTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in bpm. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: Heart rate in bpm type: object required: - unit - timestamp - value title: ClientFacingHeartRateTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: bpm value: 70 ClientFacingHypnogramTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: 'enum: 1: deep, 2: light, 3: rem, 4: awake, -1: missing_data.' timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: 'Hypnogram for sleep stages {"deep": 1, "light": 2, "rem": 3, "awake": 4, "manual": 5, "missing_data": -1}' type: object required: - unit - timestamp - start - end - value title: ClientFacingHypnogramTimeseries deprecated: true example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: stage value: 1 ClientFacingIgeTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string title: Type description: The reading type of the measurement. unit: type: string title: Unit description: Measured in FSU. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - type - unit - timestamp - value title: ClientFacingIgeTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' type: baha_grass unit: FSU value: 70 ClientFacingIggTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string title: Type description: The reading type of the measurement. unit: type: string title: Unit description: Measured in FSU. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: The value of the measurement. type: object required: - type - unit - timestamp - value title: ClientFacingIggTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' type: dairy unit: FSU value: 12 ClientFacingInhalerUsageSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingInhalerUsageSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 2 ClientFacingInsulinInjectionSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string enum: - rapid_acting - long_acting title: Type description: The insulin formulation type. ℹ️ This enum is non-exhaustive. unit: type: string const: unit title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. delivery_mode: anyOf: - type: string enum: - basal - bolus - type: 'null' title: Delivery Mode description: How the insulin was delivered. ℹ️ This enum is non-exhaustive. delivery_form: anyOf: - type: string enum: - standard - extended - type: 'null' title: Delivery Form description: For bolus deliveries, whether the dose was standard or extended. ℹ️ This enum is non-exhaustive. bolus_purpose: anyOf: - type: string enum: - meal - correction - mixed - unknown - type: 'null' title: Bolus Purpose description: For bolus deliveries, what the bolus was intended for. ℹ️ This enum is non-exhaustive. type: object required: - type - unit - timestamp - start - end - value title: ClientFacingInsulinInjectionSample example: bolus_purpose: correction delivery_form: extended delivery_mode: bolus end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' type: rapid_acting unit: unit value: 2.5 ClientFacingInsurance: properties: member_id: type: string title: Member Id payor_code: type: string title: Payor Code relationship: $ref: '#/components/schemas/ResponsibleRelationship' description: ℹ️ This enum is non-exhaustive. insured: $ref: '#/components/schemas/vital_core__schemas__db_schemas__lab_test__insurance__PersonDetails' company: $ref: '#/components/schemas/CompanyDetails' group_id: anyOf: - type: string - type: 'null' title: Group Id guarantor: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' is_primary: type: boolean title: Is Primary default: true type: object required: - member_id - payor_code - relationship - insured - company title: ClientFacingInsurance ClientFacingLab: properties: id: type: integer title: Id slug: type: string title: Slug name: type: string title: Name first_line_address: type: string title: First Line Address city: type: string title: City zipcode: type: string title: Zipcode collection_methods: items: $ref: '#/components/schemas/LabTestCollectionMethod' type: array title: Collection Methods sample_types: items: $ref: '#/components/schemas/LabTestSampleType' type: array title: Sample Types type: object required: - id - slug - name - first_line_address - city - zipcode - collection_methods - sample_types title: ClientFacingLab example: city: San Francisco collection_methods: - testkit first_line_address: 123 Main St id: 1 name: LabCorp sample_types: - saliva slug: labcorp zipcode: '91789' ClientFacingLabAccount: properties: id: type: string format: uuid title: Id lab: $ref: '#/components/schemas/Labs' description: ℹ️ This enum is non-exhaustive. org_id: anyOf: - type: string format: uuid - type: 'null' title: Org Id status: $ref: '#/components/schemas/LabAccountStatus' description: ℹ️ This enum is non-exhaustive. delegated_flow: $ref: '#/components/schemas/LabAccountDelegatedFlow' description: ℹ️ This enum is non-exhaustive. provider_account_id: type: string title: Provider Account Id account_name: anyOf: - type: string - type: 'null' title: Account Name default_clinical_notes: anyOf: - type: string - type: 'null' title: Default Clinical Notes business_units: anyOf: - items: type: string type: array - type: 'null' title: Business Units allowed_billing: additionalProperties: items: $ref: '#/components/schemas/USState' type: array propertyNames: $ref: '#/components/schemas/Billing' type: object title: Allowed Billing team_id_allowlist: items: type: string format: uuid type: array title: Team Id Allowlist type: object required: - id - lab - status - delegated_flow - provider_account_id - allowed_billing - team_id_allowlist title: ClientFacingLabAccount ClientFacingLabLocation: properties: metadata: $ref: '#/components/schemas/LabLocationMetadata' distance: type: integer title: Distance site_code: type: string title: Site Code supported_bill_types: items: $ref: '#/components/schemas/Billing' type: array title: Supported Bill Types location: $ref: '#/components/schemas/LngLat' capabilities: items: $ref: '#/components/schemas/LabLocationCapability' type: array title: Capabilities type: object required: - metadata - distance - site_code - supported_bill_types - location - capabilities title: ClientFacingLabLocation ClientFacingLabTest: properties: id: type: string format: uuid title: Id description: '' slug: type: string title: Slug description: '' name: type: string title: Name description: '' sample_type: $ref: '#/components/schemas/LabTestSampleType' description: ℹ️ This enum is non-exhaustive. method: $ref: '#/components/schemas/LabTestCollectionMethod' description: ℹ️ This enum is non-exhaustive. price: type: number title: Price description: '' is_active: type: boolean title: Is Active description: Deprecated. Use status instead. status: $ref: '#/components/schemas/LabTestStatus' description: ℹ️ This enum is non-exhaustive. fasting: type: boolean title: Fasting description: Defines whether a lab test requires fasting. default: false lab: anyOf: - $ref: '#/components/schemas/ClientFacingLab' - type: 'null' description: '' markers: anyOf: - items: $ref: '#/components/schemas/ClientFacingMarker' type: array - type: 'null' title: Markers description: '' is_delegated: type: boolean title: Is Delegated description: Deprecated and always false. Delegation is now at the lab account level. Used to denote whether a lab test requires using non-Vital physician networks. default: false deprecated: true auto_generated: type: boolean title: Auto Generated description: Whether the lab test was auto-generated by Vital default: false has_collection_instructions: anyOf: - type: boolean - type: 'null' title: Has Collection Instructions description: Whether or not the lab test has collection instructions. common_tat_days: anyOf: - type: integer - type: 'null' title: Common Tat Days description: The common turnaround time in days for the lab test. This is the expected time for the lab to process the test and return results. worst_case_tat_days: anyOf: - type: integer - type: 'null' title: Worst Case Tat Days description: The worst-case turnaround time in days for the lab test. This is the maximum time the lab may take to process the test and return results. type: object required: - id - slug - name - sample_type - method - price - is_active - status - lab - markers title: ClientFacingLabTest example: lab_test: description: Cholesterol test fasting: false has_collection_instructions: false is_delegated: false lab: city: New York first_line_address: 123 Main St name: US Specialty Lab slug: USSL zipcode: '10001' markers: - description: Hemoglobin A1c is a form of hemoglobin that is measured identify your average blood sugar levels over the past 3 months. id: 1 lab_id: 1 name: Hemoglobin A1c price: '10.00' provider_id: '1234' slug: hemoglobin-a1c type: biomarker unit: '%' method: testkit name: Lipids Panel price: 10 sample_type: dried blood spot status: active ClientFacingLabs: type: string enum: - quest - labcorp - bioreference - sonora_quest title: ClientFacingLabs description: ℹ️ This enum is non-exhaustive. ClientFacingLeanBodyMassSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: kg title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingLeanBodyMassSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: kg value: 50 ClientFacingLoinc: properties: id: type: integer title: Id name: type: string title: Name slug: type: string title: Slug code: type: string title: Code unit: anyOf: - type: string - type: 'null' title: Unit type: object required: - id - name - slug - code title: ClientFacingLoinc example: code: 1234-1 id: 1 name: Hemoglobin A1c slug: hemoglobin-a1c unit: '%' ClientFacingMarker: properties: id: type: integer title: Id name: type: string title: Name slug: type: string title: Slug description: anyOf: - type: string - type: 'null' title: Description lab_id: anyOf: - type: integer - type: 'null' title: Lab Id provider_id: anyOf: - type: string - type: 'null' title: Provider Id type: anyOf: - $ref: '#/components/schemas/MarkerType' - type: 'null' description: ℹ️ This enum is non-exhaustive. unit: anyOf: - type: string - type: 'null' title: Unit price: anyOf: - type: string - type: 'null' title: Price aoe: anyOf: - $ref: '#/components/schemas/AoE' - type: 'null' a_la_carte_enabled: type: boolean title: A La Carte Enabled default: false common_tat_days: anyOf: - type: integer - type: 'null' title: Common Tat Days worst_case_tat_days: anyOf: - type: integer - type: 'null' title: Worst Case Tat Days is_orderable: anyOf: - type: boolean - type: 'null' title: Is Orderable default: true type: object required: - id - name - slug title: ClientFacingMarker example: aoe: questions: - answers: - code: answer_code id: 1 value: answer_value code: question_code id: 1 value: question_value common_tat_days: 3 description: Hemoglobin A1c is a form of hemoglobin that is measured identify your average blood sugar levels over the past 3 months. id: 1 is_orderable: true lab_id: 1 name: Hemoglobin A1c price: '10.00' provider_id: '1234' slug: hemoglobin-a1c type: biomarker unit: '%' worst_case_tat_days: 5 ClientFacingMarkerComplete: properties: id: type: integer title: Id name: type: string title: Name slug: type: string title: Slug description: anyOf: - type: string - type: 'null' title: Description lab_id: anyOf: - type: integer - type: 'null' title: Lab Id provider_id: anyOf: - type: string - type: 'null' title: Provider Id type: anyOf: - $ref: '#/components/schemas/MarkerType' - type: 'null' description: ℹ️ This enum is non-exhaustive. unit: anyOf: - type: string - type: 'null' title: Unit price: anyOf: - type: string - type: 'null' title: Price aoe: anyOf: - $ref: '#/components/schemas/AoE' - type: 'null' a_la_carte_enabled: type: boolean title: A La Carte Enabled default: false common_tat_days: anyOf: - type: integer - type: 'null' title: Common Tat Days worst_case_tat_days: anyOf: - type: integer - type: 'null' title: Worst Case Tat Days is_orderable: anyOf: - type: boolean - type: 'null' title: Is Orderable default: true expected_results: items: $ref: '#/components/schemas/ClientFacingResult' type: array title: Expected Results type: object required: - id - name - slug - expected_results title: ClientFacingMarkerComplete example: description: Hemoglobin A1c is a form of hemoglobin that is measured identify your average blood sugar levels over the past 3 months. expected_results: - id: 1 lab_id: 1 loinc: code: 4548-4 id: 1 name: HbA1c (Bld) [Mass fraction] slug: hba1c-bld-mass-fraction unit: '%' name: Hemoglobin A1c provider_id: '1234' slug: hemoglobin-a1c id: 1 lab_id: 1 name: Hemoglobin A1c price: '10.00' provider_id: '1234' slug: hemoglobin-a1c type: biomarker unit: '%' ClientFacingMealResponse: properties: meals: items: $ref: '#/components/schemas/MealInDBBase_ClientFacingSource_' type: array title: Meals type: object required: - meals title: ClientFacingMealResponse example: meals: - calendar_date: '2019-08-24' created_at: '2023-02-27T20:31:24+00:00' data: Chiken coquet starter: energy: unit: kcal value: 400 macros: carbs: 75 fats: monounsaturated: 1 omega3: 0 omega6: 0 polyunsaturated: 1 saturated: 98 total: 100 protein: 10 sugar: 25 micros: minerals: sodium: 500 Coffee, black, 1 tbsp(s): energy: unit: kcal value: 0 macros: carbs: 0 fats: total: 0 protein: 0 sugar: 0 micros: minerals: sodium: 0 id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Dinner priority_id: 42 provider_id: '123456' source: app_id: com.myfitnesspal.mfp device_id: 550e8400-e29b-41d4-a716-446655440000 provider: apple_health_kit type: unknown source_app_id: com.myfitnesspal.mfp source_id: 10 timestamp: '2019-08-24T00:00:00Z' updated_at: '2023-02-28T01:22:38+00:00' user_id: a169451c-8525-4352-b8ca-070dd449a1a5 ClientFacingMenstrualCycle: properties: id: type: string format: uuid title: Id period_start: type: string format: date title: Period Start period_end: anyOf: - type: string format: date - type: 'null' title: Period End cycle_end: anyOf: - type: string format: date - type: 'null' title: Cycle End is_predicted: type: boolean title: Is Predicted default: false menstrual_flow: items: $ref: '#/components/schemas/MenstrualFlowEntry' type: array title: Menstrual Flow cervical_mucus: items: $ref: '#/components/schemas/CervicalMucusEntry' type: array title: Cervical Mucus intermenstrual_bleeding: items: $ref: '#/components/schemas/IntermenstrualBleedingEntry' type: array title: Intermenstrual Bleeding contraceptive: items: $ref: '#/components/schemas/ContraceptiveEntry' type: array title: Contraceptive detected_deviations: items: $ref: '#/components/schemas/DetectedDeviationEntry' type: array title: Detected Deviations ovulation_test: items: $ref: '#/components/schemas/OvulationTestEntry' type: array title: Ovulation Test home_pregnancy_test: items: $ref: '#/components/schemas/HomePregnancyTestEntry' type: array title: Home Pregnancy Test home_progesterone_test: items: $ref: '#/components/schemas/HomeProgesteroneTestEntry' type: array title: Home Progesterone Test sexual_activity: items: $ref: '#/components/schemas/SexualActivityEntry' type: array title: Sexual Activity basal_body_temperature: items: $ref: '#/components/schemas/BasalBodyTemperatureEntry' type: array title: Basal Body Temperature source_provider: anyOf: - $ref: '#/components/schemas/Providers' - $ref: '#/components/schemas/Labs' title: Source Provider description: ℹ️ This enum is non-exhaustive. source_type: type: string enum: - unknown - phone - watch - app - multiple_sources - fingerprick - cuff - manual_scan - automatic - insulin_pump - scale - chest_strap - ring - lab - exercise_machine - earphone title: Source Type description: ℹ️ This enum is non-exhaustive. source_app_id: anyOf: - type: string - type: 'null' title: Source App Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At user_id: type: string format: uuid title: User Id source: $ref: '#/components/schemas/ClientFacingSource' type: object required: - id - period_start - source_provider - source_type - user_id - source - created_at - updated_at title: MenstrualCycle example: basal_body_temperature: [] cervical_mucus: [] contraceptive: [] created_at: '2023-02-27T20:31:24+00:00' cycle_end: '2024-05-01' detected_deviations: [] home_pregnancy_test: [] home_progesterone_test: [] id: e1274c3e-c035-4bd7-86aa-2eb15d6d0137 intermenstrual_bleeding: - date: '2024-04-17' is_predicted: false menstrual_flow: - date: '2024-04-07' flow: light - date: '2024-04-10' flow: medium - date: '2024-04-11' flow: heavy ovulation_test: [] period_end: '2024-04-11' period_start: '2024-04-07' sexual_activity: - date: '2024-04-13' protection_used: true source: app_id: com.apple.Health device_id: 550e8400-e29b-41d4-a716-446655440000 provider: apple_health_kit type: app source_app_id: com.apple.Health source_provider: apple_health_kit source_type: app updated_at: '2023-02-28T01:22:38+00:00' user_id: cbd8b986-4225-4d36-8e2c-046ff2702769 ClientFacingMindfulnessMinutesTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in minutes. timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: Number of minutes spent in a mindful state. type: object required: - unit - timestamp - start - end - value title: ClientFacingMindfulnessMinutesTimeseries example: end: '2026-05-20T13:48:41.621257+00:00' start: '2023-02-13T14:57:24+00:00' unit: min value: 42 ClientFacingNoteSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: User notes as text. timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: string title: Value description: The recorded value for the interval. tags: anyOf: - items: type: string enum: - food - exercise - insulin_injection - unspecified type: array - type: 'null' title: Tags description: What the note refers to. type: object required: - unit - timestamp - start - end - value title: ClientFacingNoteSample example: end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' tags: - food - exercise unit: text value: Lorem ipsum dolor sit amet ClientFacingOnSiteCollectionOrder: properties: id: type: string format: uuid title: Id description: The Junction on-site collection Order ID created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - created_at - updated_at title: ClientFacingOnSiteCollectionOrder description: 'Schema for an on-site collection order in the client facing API. To be used as part of a ClientFacingOrder.' example: created_at: '2020-01-01T00:00:00Z' id: 64d787c3-825d-462b-bf0c-5b895f7a9bf5 updated_at: '2020-01-01T00:00:00Z' ClientFacingOnSiteCollectionOrderDetails: properties: type: type: string const: on_site_collection title: Type data: anyOf: - $ref: '#/components/schemas/ClientFacingOnSiteCollectionOrder' - type: 'null' type: object required: - type title: ClientFacingOnSiteCollectionOrderDetails ClientFacingOrder: properties: user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. id: type: string format: uuid title: Id description: The Vital Order ID team_id: type: string format: uuid title: Team Id description: Your team id. patient_details: anyOf: - $ref: '#/components/schemas/ClientFacingPatientDetailsCompatible' - type: 'null' description: Patient Details patient_address: anyOf: - $ref: '#/components/schemas/PatientAddressCompatible' - type: 'null' description: Patient Address lab_test: $ref: '#/components/schemas/ClientFacingLabTest' description: The Vital Test associated with the order details: anyOf: - $ref: '#/components/schemas/ClientFacingWalkInOrderDetails' - $ref: '#/components/schemas/ClientFacingTestKitOrderDetails' - $ref: '#/components/schemas/ClientFacingAtHomePhlebotomyOrderDetails' - $ref: '#/components/schemas/ClientFacingOnSiteCollectionOrderDetails' title: Details sample_id: anyOf: - type: string - type: 'null' title: Sample Id description: Sample ID notes: anyOf: - type: string - type: 'null' title: Notes description: Notes associated with the order clinical_notes: anyOf: - type: string - type: 'null' title: Clinical Notes created_at: type: string format: date-time title: Created At description: When your order was created updated_at: type: string format: date-time title: Updated At description: When your order was last updated. events: items: $ref: '#/components/schemas/ClientFacingOrderEvent' type: array title: Events status: anyOf: - $ref: '#/components/schemas/OrderTopLevelStatus' - type: 'null' description: The top-level status of the latest event for this order. This field is deprecated. Please use `last_event` instead. ℹ️ This enum is non-exhaustive. deprecated: true last_event: $ref: '#/components/schemas/ClientFacingOrderEvent' description: The latest event in the order's lifecycle. physician: anyOf: - $ref: '#/components/schemas/ClientFacingPhysician' - type: 'null' health_insurance_id: anyOf: - type: string format: uuid - type: 'null' title: Health Insurance Id description: Vital ID of the health insurance. requisition_form_url: anyOf: - type: string - type: 'null' title: Requisition Form Url description: DEPRECATED. Requistion form url. priority: type: boolean title: Priority description: Defines whether order is priority or not. For some labs, this refers to a STAT order. default: false shipping_details: anyOf: - $ref: '#/components/schemas/ShippingAddress' - type: 'null' description: Shipping Details. For unregistered testkit orders. activate_by: anyOf: - type: string format: date - type: 'null' title: Activate By description: Schedule an Order to be processed in a future date. passthrough: anyOf: - type: string - type: 'null' title: Passthrough billing_type: $ref: '#/components/schemas/Billing' default: client_bill description: ℹ️ This enum is non-exhaustive. icd_codes: anyOf: - items: type: string type: array - type: 'null' title: Icd Codes has_abn: type: boolean title: Has Abn description: Defines whether the order has an Advanced Beneficiary Notice (ABN) form or not. interpretation: anyOf: - $ref: '#/components/schemas/Interpretation' - type: 'null' description: Interpretation of the order result. Can be one of (normal, abnormal, critical). ℹ️ This enum is non-exhaustive. has_missing_results: anyOf: - type: boolean - type: 'null' title: Has Missing Results description: Defines whether the order result has missing biomarkers. expected_result_by_date: anyOf: - type: string format: date - type: 'null' title: Expected Result By Date description: The common-case date by which the order result is expected to be available. worst_case_result_by_date: anyOf: - type: string format: date - type: 'null' title: Worst Case Result By Date description: The latest date by which the order result is expected to be available. origin: anyOf: - $ref: '#/components/schemas/OrderOrigin' - type: 'null' description: ℹ️ This enum is non-exhaustive. order_transaction: anyOf: - $ref: '#/components/schemas/ClientFacingOrderTransaction' - type: 'null' type: object required: - user_id - id - team_id - patient_details - patient_address - lab_test - details - sample_id - notes - created_at - updated_at - events - last_event - health_insurance_id - requisition_form_url - shipping_details - has_abn title: ClientFacingOrder example: activate_by: '2020-01-01' created_at: '2020-01-01T00:00:00Z' details: data: created_at: '2020-01-01T00:00:00Z' id: a655f0e4-6405-4a1d-80b7-66f06c2108a7 shipment: created_at: '2020-01-01T00:00:00.000Z' id: d55210cc-3d9f-4115-8262-5013f700c7be inbound_courier: usps inbound_tracking_number: inbound_tracking_url: notes: outbound_courier: usps outbound_tracking_number: outbound_tracking_url: updated_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00Z' type: testkit events: - created_at: '2022-01-01T00:00:00Z' id: 1 status: received.testkit.ordered - created_at: '2022-01-02T00:00:00Z' id: 2 status: received.testkit.requisition_created - created_at: '2022-01-03T00:00:00Z' id: 3 status: collecting_sample.testkit.transit_customer has_abn: false health_insurace_id: 1b0518f4-02cd-4b5f-a009-8015da6e9654 id: 304bdcdb-3ab5-41f3-ba97-de1a6702bd39 lab_test: description: Cholesterol test method: testkit name: Lipids Panel last_event: created_at: '2022-01-03T00:00:00Z' id: 3 status: collecting_sample.testkit.transit_customer notes: This is a note order_transaction: id: a655f0e4-6405-4a1d-80b7-66f06c2108a7 orders: - created_at: '2020-01-01T00:00:00Z' id: d55210cc-3d9f-4115-8262-5013f700c7be low_level_status: transit_customer low_level_status_created_at: '2020-01-05T00:00:00Z' origin: initial updated_at: '2020-01-05T00:00:00Z' - created_at: '2020-01-05T01:00:00Z' id: e66321dd-4e0g-5226-9373-6124g811d8cf low_level_status: requisition_created low_level_status_created_at: '2020-01-05T01:00:00Z' origin: redraw updated_at: '2020-01-05T01:00:00Z' status: active origin: initial patient_address: city: San Francisco country: United States first_line: 123 Main St. phone_number: '+11234567890' receiver_name: John Doe second_line: Apt. 208 state: CA zip: '91189' patient_details: dob: '2020-01-01' gender: male requisition_form_url: https://www.example.com sample_id: '123456789' status: collecting_sample team_id: 8b394366-3502-48e9-a07a-f9503091fd9c updated_at: '2020-01-01T00:00:00Z' user_id: 1fb6c1b6-9572-4596-8cfd-930e45ea9d01 ClientFacingOrderEvent: properties: id: type: integer title: Id created_at: type: string format: date-time title: Created At status: $ref: '#/components/schemas/OrderStatus' description: ℹ️ This enum is non-exhaustive. status_detail: anyOf: - $ref: '#/components/schemas/OrderStatusDetail' - type: 'null' description: ℹ️ This enum is non-exhaustive. type: object required: - id - created_at - status title: ClientFacingOrderEvent ClientFacingOrderInTransaction: properties: id: type: string format: uuid title: Id low_level_status: anyOf: - $ref: '#/components/schemas/OrderLowLevelStatus' - type: 'null' description: ℹ️ This enum is non-exhaustive. low_level_status_created_at: anyOf: - type: string format: date-time - type: 'null' title: Low Level Status Created At origin: anyOf: - $ref: '#/components/schemas/OrderOrigin' - type: 'null' description: ℹ️ This enum is non-exhaustive. parent_id: anyOf: - type: string format: uuid - type: 'null' title: Parent Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - created_at - updated_at title: ClientFacingOrderInTransaction description: Minimal order info for embedding in order_transaction payload. ClientFacingOrderTransaction: properties: id: type: string format: uuid title: Id status: $ref: '#/components/schemas/OrderTransactionStatus' description: ℹ️ This enum is non-exhaustive. orders: items: $ref: '#/components/schemas/ClientFacingOrderInTransaction' type: array title: Orders type: object required: - id - status - orders title: ClientFacingOrderTransaction description: Order transaction info. ClientFacingPatientDetailsCompatible: properties: first_name: anyOf: - type: string - type: 'null' title: First Name last_name: anyOf: - type: string - type: 'null' title: Last Name dob: type: string format: date-time title: Dob gender: type: string title: Gender phone_number: anyOf: - type: string - type: 'null' title: Phone Number email: anyOf: - type: string - type: 'null' title: Email medical_proxy: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' description: Parent/medical_proxy details. Required if patient is a minor. race: anyOf: - $ref: '#/components/schemas/Race' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. ethnicity: anyOf: - $ref: '#/components/schemas/Ethnicity' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. sexual_orientation: anyOf: - $ref: '#/components/schemas/SexualOrientation' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. gender_identity: anyOf: - $ref: '#/components/schemas/GenderIdentity' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. type: object required: - dob - gender title: ClientFacingPatientDetailsCompatible ClientFacingPayor: properties: payor_code: type: string title: Payor Code description: Payor code returned for the insurance information. name: type: string title: Name description: Insurance name returned for the insurance information. aliases: items: type: string type: array title: Aliases description: Insurance name aliases returned for the insurance information. org_address: $ref: '#/components/schemas/Address' description: Insurance business address returned for the insurance information. source: $ref: '#/components/schemas/ClientFacingPayorCodeSource' description: The source of the payor, can be one of (platform, team). ℹ️ This enum is non-exhaustive. type: object required: - payor_code - name - aliases - org_address - source title: ClientFacingPayor ClientFacingPayorCodeSource: type: string enum: - platform - team title: ClientFacingPayorCodeSource description: ℹ️ This enum is non-exhaustive. ClientFacingPayorSearchResponse: properties: payor_code: type: string title: Payor Code description: Payor code returned for the insurance information. name: type: string title: Name description: Insurance name returned for the insurance information. aliases: items: type: string type: array title: Aliases description: Insurance name aliases returned for the insurance information. org_address: $ref: '#/components/schemas/Address' description: Insurance business address returned for the insurance information. source: $ref: '#/components/schemas/ClientFacingPayorCodeSource' description: The source of the payor, can be one of (platform, team). ℹ️ This enum is non-exhaustive. type: object required: - payor_code - name - aliases - org_address - source title: ClientFacingPayorSearchResponse ClientFacingPayorSearchResponseDeprecated: properties: code: type: string title: Code description: Payor code returned for the insurance information. name: type: string title: Name description: Insurance name returned for the insurance information. aliases: items: type: string type: array title: Aliases description: Insurance name aliases returned for the insurance information. org_address: $ref: '#/components/schemas/Address' description: Insurance business address returned for the insurance information. source: $ref: '#/components/schemas/ClientFacingPayorCodeSource' description: The source of the payor, can be one of (platform, team). ℹ️ This enum is non-exhaustive. type: object required: - code - name - aliases - org_address - source title: ClientFacingPayorSearchResponseDeprecated ClientFacingPeakExpiratoryFlowRateSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: L/min title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingPeakExpiratoryFlowRateSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L/min value: 450 ClientFacingPhysician: properties: first_name: type: string title: First Name last_name: type: string title: Last Name npi: type: string title: Npi type: object required: - first_name - last_name - npi title: ClientFacingPhysician ClientFacingProfile: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. height: anyOf: - type: integer - type: 'null' title: Height birth_date: anyOf: - type: string format: date - type: 'null' title: Birth Date wheelchair_use: anyOf: - type: boolean const: true - type: 'null' title: Wheelchair Use gender: anyOf: - $ref: '#/components/schemas/Gender' - type: 'null' description: ℹ️ This enum is non-exhaustive. sex: anyOf: - $ref: '#/components/schemas/Sex' - type: 'null' description: ℹ️ This enum is non-exhaustive. source: $ref: '#/components/schemas/ClientFacingSource' created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - user_id - source - created_at - updated_at title: ClientFacingProfile example: created_at: '2023-02-27T20:31:24+00:00' height: 183 id: ceb39d90-5ba6-472b-9cb8-b5c128da5038 source: logo: https://logo_url.com name: Oura slug: oura updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientFacingProvider: properties: name: type: string title: Name description: Name of source of information slug: type: string title: Slug description: Slug for designated source logo: type: string title: Logo description: URL for source logo type: object required: - name - slug - logo title: Provider description: A vendor, a service, or a platform which Vital can connect with. example: logo: https://logo_url.com name: Oura slug: oura ClientFacingProviderDetailed: properties: name: type: string title: Name description: Name of source of information slug: type: string title: Slug description: Slug for designated source description: type: string title: Description description: Description of source of information logo: anyOf: - type: string - type: 'null' title: Logo description: URL for source logo auth_type: anyOf: - $ref: '#/components/schemas/SourceAuthType' - type: 'null' description: ℹ️ This enum is non-exhaustive. supported_resources: items: $ref: '#/components/schemas/Resource' type: array title: Supported Resources default: [] type: object required: - name - slug - description - logo title: Provider example: auth_type: oauth logo: https://logo_url.com name: Oura slug: oura supported_resources: - workouts - sleep ClientFacingProviderWithStatus: properties: name: type: string title: Name description: Name of source of information slug: type: string title: Slug description: Slug for designated source logo: type: string title: Logo description: URL for source logo created_on: type: string format: date-time title: Created On status: type: string title: Status description: Status of source, either error or connected external_user_id: anyOf: - type: string - type: 'null' title: External User Id description: ' The unique identifier of the associated external data provider user. * OAuth Providers: User unique identifier; provider-specific formats * Password Providers: Username * Email Providers: Email * Junction Mobile SDK Providers: `null` (not available) ' error_details: anyOf: - $ref: '#/components/schemas/ClientFacingConnectionErrorDetails' - type: 'null' description: Details of the terminal connection error — populated only when the status is `error`. resource_availability: additionalProperties: $ref: '#/components/schemas/ResourceAvailability' propertyNames: $ref: '#/components/schemas/Resource' type: object title: Resource Availability type: object required: - name - slug - logo - created_on - status - resource_availability title: Provider example: created_on: '2010-01-23T12:34:56+00:00' error_details: error_message: The user has deregistered the connection per notification from Garmin. error_type: deregistered_per_provider errored_at: '2010-01-24T23:45:32+00:00' logo: https://logo_url.com name: Garmin resource_availability: sleep: scope_requirements: user_denied: optional: - spo2Daily required: [] user_granted: optional: [] required: - daily status: available slug: garmin status: error ClientFacingRespiratoryRateTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in bpm. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: Average respiratory rate::breaths per minute type: object required: - unit - timestamp - value title: ClientFacingRespiratoryRateTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: bpm value: 15.5 ClientFacingResult: properties: id: type: integer title: Id name: type: string title: Name slug: type: string title: Slug lab_id: anyOf: - type: integer - type: 'null' title: Lab Id provider_id: anyOf: - type: string - type: 'null' title: Provider Id required: type: boolean title: Required loinc: anyOf: - $ref: '#/components/schemas/ClientFacingLoinc' - type: 'null' type: object required: - id - name - slug - required title: ClientFacingResult example: id: 1 lab_id: 1 loinc: code: 1234-1 id: 1 name: Hemoglobin A1c slug: hemoglobin-a1c unit: '%' name: Hemoglobin A1c provider_id: '1234' slug: hemoglobin-a1c ClientFacingShallowWorkoutStream: properties: user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. workout_id: type: string format: uuid title: Workout Id provider_id: type: string title: Provider Id message: type: string title: Message default: Due to payload size limits, to access the workout stream, please use the /v2/timeseries/workouts/{workout_id}/stream endpoint. source: $ref: '#/components/schemas/ClientFacingSource' description: Source the data has come from. sport: $ref: '#/components/schemas/ClientFacingSport' description: Sport's name default: '' type: object required: - user_id - workout_id - provider_id - source title: ClientFacingShallowWorkoutStream example: message: Due to payload size limits, to access the workout stream, please use the /v2/timeseries/workouts/{workout_id}/stream endpoint. provider_id: 123dashd9 source: logo: https://logo_url.com name: Oura slug: oura sport: id: 1 name: Running slug: running workout_id: 185d0f34-dfc0-429f-84f9-b24030914bdd ClientFacingShipment: properties: id: type: string format: uuid title: Id description: The Vital Shipment ID outbound_tracking_number: anyOf: - type: string - type: 'null' title: Outbound Tracking Number description: Tracking number for delivery to customer outbound_tracking_url: anyOf: - type: string - type: 'null' title: Outbound Tracking Url description: Tracking url for delivery to customer inbound_tracking_number: anyOf: - type: string - type: 'null' title: Inbound Tracking Number description: Tracking number for delivery to lab inbound_tracking_url: anyOf: - type: string - type: 'null' title: Inbound Tracking Url description: Tracking url for delivery to lab outbound_courier: anyOf: - type: string - type: 'null' title: Outbound Courier description: Courier used for delivery to customer inbound_courier: anyOf: - type: string - type: 'null' title: Inbound Courier description: Courier used for delivery to lab notes: anyOf: - type: string - type: 'null' title: Notes description: Notes associated to the Vital shipment type: object required: - id - outbound_tracking_number - outbound_tracking_url - inbound_tracking_number - inbound_tracking_url - outbound_courier - inbound_courier - notes title: ClientFacingShipment description: 'Schema for a Shipment in the client facing API. To be used as part of a ClientFacingTestkitOrder.' example: id: 6d249293-7ee9-4c7f-8889-113ccbf5f89b inbound_courier: usps inbound_tracking_number: inbound_tracking_url: notes: outbound_courier: usps outbound_tracking_number: outbound_tracking_url: ClientFacingSleep: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. date: type: string format: date-time title: Date description: Date of the specified record, formatted as ISO8601 datetime string in UTC 00:00. Deprecated in favour of calendar_date. deprecated: true calendar_date: type: string format: date title: Calendar Date description: Date of the sleep summary in the YYYY-mm-dd format. This generally matches the sleep end date. bedtime_start: type: string format: date-time title: Bedtime Start description: UTC Time when the sleep period started bedtime_stop: type: string format: date-time title: Bedtime Stop description: UTC Time when the sleep period ended type: $ref: '#/components/schemas/SleepType' description: "\n`long_sleep`: >=3 hours of sleep;\n`short_sleep`: <3 hours of sleep;\n`acknowledged_nap`: User-acknowledged\ \ naps, typically under 3 hours of sleep;\n`unknown`: The sleep session recording is ongoing.\n ℹ️ This enum is\ \ non-exhaustive." timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds duration: type: integer title: Duration description: Total duration of the sleep period (sleep.duration = sleep.bedtime_end - sleep.bedtime_start)::seconds total: type: integer title: Total description: Total amount of sleep registered during the sleep period (sleep.total = sleep.rem + sleep.light + sleep.deep)::seconds awake: type: integer title: Awake description: Total amount of awake time registered during the sleep period::seconds light: type: integer title: Light description: Total amount of light sleep registered during the sleep period::seconds rem: type: integer title: Rem description: Total amount of REM sleep registered during the sleep period, minutes::seconds deep: type: integer title: Deep description: Total amount of deep (N3) sleep registered during the sleep period::seconds score: anyOf: - type: integer - type: 'null' title: Score description: A value between 1 and 100 representing how well the user slept. Currently only available for Withings, Oura, Whoop and Garmin::scalar recovery_readiness_score: anyOf: - type: integer - type: 'null' title: Recovery Readiness Score description: A value between 0 and 100 representing the provider's recovery/readiness proxy. Currently sourced from Oura readiness score, Whoop recovery score, and Ultrahuman recovery::scalar hr_lowest: anyOf: - type: integer - type: 'null' title: Hr Lowest description: The lowest heart rate (5 minutes sliding average) registered during the sleep period::beats per minute hr_average: anyOf: - type: integer - type: 'null' title: Hr Average description: The average heart rate registered during the sleep period::beats per minute hr_resting: anyOf: - type: integer - type: 'null' title: Hr Resting description: Resting heart rate recorded during a sleep session::bpm efficiency: anyOf: - type: number - type: 'null' title: Efficiency description: Sleep efficiency is the percentage of the sleep period spent asleep (100% * sleep.total / sleep.duration)::perc latency: anyOf: - type: integer - type: 'null' title: Latency description: Detected latency from bedtime_start to the beginning of the first five minutes of persistent sleep::seconds temperature_delta: anyOf: - type: number - type: 'null' title: Temperature Delta description: Skin temperature deviation from the long-term temperature average::celcius skin_temperature: anyOf: - type: number - type: 'null' title: Skin Temperature description: The skin temperature::celcius hr_dip: anyOf: - type: number - type: 'null' title: Hr Dip description: Sleeping Heart Rate Dip is the percentage difference between your average waking heart rate and your average sleeping heart rate. In health studies, a greater "dip" is typically seen as a positive indicator of overall health. Currently only available for Garmin::perc state: anyOf: - $ref: '#/components/schemas/SleepSummaryState' - type: 'null' description: Some providers can provide updates to the sleep summary hours after the sleep period has ended. This field indicates the state of the sleep summary. For example, TENTATIVE means the summary is an intial prediction from the provider and can be subject to change. Currently only available for Garmin and EightSleep::str ℹ️ This enum is non-exhaustive. average_hrv: anyOf: - type: number - type: 'null' title: Average Hrv description: The average heart rate variability registered during the sleep period::rmssd respiratory_rate: anyOf: - type: number - type: 'null' title: Respiratory Rate description: Average respiratory rate::breaths per minute source: $ref: '#/components/schemas/ClientFacingSource' description: Source the data has come from. sleep_stream: anyOf: - $ref: '#/components/schemas/ClientFacingSleepStream' - type: 'null' deprecated: true created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - user_id - date - calendar_date - bedtime_start - bedtime_stop - type - duration - total - awake - light - rem - deep - source - created_at - updated_at title: Sleep Data example: average_hrv: 78 awake: 2400 bedtime_start: '2023-02-27T12:31:24+00:00' bedtime_stop: '2023-02-27T12:31:24+00:00' calendar_date: '2023-02-27' created_at: '2023-02-27T20:31:24+00:00' date: '2023-02-27T12:31:24+00:00' deep: 2400 duration: 28800 efficiency: 0.97 hr_average: 50 hr_lowest: 43 id: e2e0eb04-6641-4858-9de5-649efb41b346 latency: 1000 light: 2400 recovery_readiness_score: 82 rem: 2400 respiratory_rate: 14 skin_temperature: 36.5 source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: oura type: unknown temperature_delta: -0.2 timezone_offset: 2400 total: 28800 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientFacingSleepApneaAlertSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingSleepApneaAlertSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 ClientFacingSleepBreathingDisturbanceSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string enum: - elevated - not_elevated - type: 'null' title: Type description: The type of sleep breathing disturbance. ℹ️ This enum is non-exhaustive. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - type - unit - timestamp - start - end - value title: ClientFacingSleepBreathingDisturbanceSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' type: elevated unit: count value: 12 ClientFacingSleepCycle: properties: id: type: string format: uuid title: Id sleep_id: type: string format: uuid title: Sleep Id session_start: type: string format: date-time title: Session Start session_end: type: string format: date-time title: Session End stage_start_offset_second: items: type: integer type: array title: Stage Start Offset Second stage_end_offset_second: items: type: integer type: array title: Stage End Offset Second stage_type: items: $ref: '#/components/schemas/VitalSleepStage' type: array title: Stage Type description: ' Sleep stage classification: `-1`: Unknown or unclassified sleep stage; `1`: Deep sleep; `2`: Light/non-REM sleep; `3`: Rapid Eye Movement sleep; `4`: Awake period; `5`: Manually classified stage. ' examples: - - 1 - 3 time_zone: anyOf: - type: string - type: 'null' title: Time Zone source_provider: anyOf: - $ref: '#/components/schemas/Providers' - $ref: '#/components/schemas/Labs' title: Source Provider description: ℹ️ This enum is non-exhaustive. source_type: type: string enum: - unknown - phone - watch - app - multiple_sources - fingerprick - cuff - manual_scan - automatic - insulin_pump - scale - chest_strap - ring - lab - exercise_machine - earphone title: Source Type description: ℹ️ This enum is non-exhaustive. source_app_id: anyOf: - type: string - type: 'null' title: Source App Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At user_id: type: string format: uuid title: User Id source: $ref: '#/components/schemas/ClientFacingSource' type: object required: - id - sleep_id - session_start - session_end - stage_start_offset_second - stage_end_offset_second - stage_type - source_provider - source_type - user_id - source - created_at - updated_at title: Sleep Cycle example: created_at: '2023-02-27T20:31:24+00:00' id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b session_end: '2022-01-01T08:00:00' session_start: '2022-01-01T00:00:00' sleep_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: oura type: ring source_provider: oura source_type: ring stage_end_offset_second: - 300 - 600 - 900 - 1200 stage_start_offset_second: - 0 - 300 - 600 - 900 stage_type: - 1 - 2 - 3 - 1 time_zone: America/Los_Angeles updated_at: '2023-02-28T01:22:38+00:00' user_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b ClientFacingSleepStream: properties: hrv: anyOf: - items: $ref: '#/components/schemas/ClientFacingHRVTimeseries' type: array - type: 'null' title: Hrv default: [] heartrate: anyOf: - items: $ref: '#/components/schemas/ClientFacingHeartRateTimeseries' type: array - type: 'null' title: Heartrate default: [] hypnogram: anyOf: - items: $ref: '#/components/schemas/ClientFacingHypnogramTimeseries' type: array - type: 'null' title: Hypnogram default: [] respiratory_rate: anyOf: - items: $ref: '#/components/schemas/ClientFacingRespiratoryRateTimeseries' type: array - type: 'null' title: Respiratory Rate default: [] type: object title: Sleep stream data example: heartrate: - id: 0 timestamp: '2026-05-20T13:43:41.731693+00:00' unit: bpm value: 16 - id: 1 timestamp: '2026-05-20T13:44:11.731712+00:00' unit: bpm value: 93 - id: 2 timestamp: '2026-05-20T13:44:41.731730+00:00' unit: bpm value: 187 - id: 3 timestamp: '2026-05-20T13:45:11.731772+00:00' unit: bpm value: 21 - id: 4 timestamp: '2026-05-20T13:45:41.731794+00:00' unit: bpm value: 148 hrv: - id: 0 timestamp: '2026-05-20T13:43:41.731486+00:00' unit: rmssd value: 36 - id: 1 timestamp: '2026-05-20T13:44:11.731579+00:00' unit: rmssd value: 100 - id: 2 timestamp: '2026-05-20T13:44:41.731621+00:00' unit: rmssd value: 43 - id: 3 timestamp: '2026-05-20T13:45:11.731650+00:00' unit: rmssd value: 98 - id: 4 timestamp: '2026-05-20T13:45:41.731672+00:00' unit: rmssd value: 8 hypnogram: - id: 0 timestamp: '2026-05-20T13:43:41.731815+00:00' unit: stage value: 4 - id: 1 timestamp: '2026-05-20T13:44:11.731833+00:00' unit: stage value: 4 - id: 2 timestamp: '2026-05-20T13:44:41.731851+00:00' unit: stage value: 3 - id: 3 timestamp: '2026-05-20T13:45:11.731868+00:00' unit: stage value: 1 - id: 4 timestamp: '2026-05-20T13:45:41.731884+00:00' unit: stage value: 0 respiratory_rate: - id: 0 timestamp: '2026-05-20T13:43:41.731904+00:00' unit: bpm value: 15 - id: 1 timestamp: '2026-05-20T13:44:11.731921+00:00' unit: bpm value: 26 - id: 2 timestamp: '2026-05-20T13:44:41.731937+00:00' unit: bpm value: 23 - id: 3 timestamp: '2026-05-20T13:45:11.731951+00:00' unit: bpm value: 14 - id: 4 timestamp: '2026-05-20T13:45:41.731965+00:00' unit: bpm value: 24 ClientFacingSource: properties: provider: type: string title: Provider description: Provider slug. e.g., `oura`, `fitbit`, `garmin`. type: type: string title: Type description: The type of the data source (app or device) by which the summary or the timeseries data were recorded. This defaults to `unknown` when Vital cannot extract or infer that information default: unknown app_id: anyOf: - type: string - type: 'null' title: App Id description: The identifier of the app which recorded this summary. This is only applicable to multi-source providers like Apple Health and Android Health Connect. device_id: anyOf: - type: string format: uuid - type: 'null' title: Device Id description: The identifier of the device which recorded this summary. sport: anyOf: - type: string - type: 'null' title: Sport description: ' For workout stream timeseries, this is the standard sport slug of the workout with which the timeseries data are associated. For the `distance` timeseries, this is `wheelchair_pushing` if the user is a wheelchair user, or `null` otherwise. For all summary types and non-workout timeseries, this is always `null`. ' workout_id: anyOf: - type: string format: uuid - type: 'null' title: Workout Id description: ' For workout stream timeseries, this is the workout ID with which the timeseries data are associated. For all other types, this is always `null`. ' name: type: string title: Name description: Deprecated. Subject to removal after 1 Jan 2024. default: '' deprecated: true slug: type: string title: Slug description: Deprecated. Use `provider` instead. Subject to removal after 1 Jan 2024. default: '' deprecated: true logo: type: string title: Logo description: Deprecated. Subject to removal after 1 Jan 2024. default: '' deprecated: true type: object required: - provider title: Source description: 'Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.' example: provider: oura type: ring ClientFacingSport: properties: id: type: integer title: Id description: This ID is unstable across environments. Use the slug instead. deprecated: true name: type: string title: Name description: Sport's name slug: type: string title: Slug description: Slug for designated sport type: object required: - id - name - slug title: ClientFacingSport ClientFacingStandDurationSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: min title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingStandDurationSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: min value: 15 ClientFacingStandHourSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: type: string enum: - stood - idle title: Type description: The type of stand hour. ℹ️ This enum is non-exhaustive. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - type - unit - timestamp - start - end - value title: ClientFacingStandHourSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 ClientFacingStepsTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit description: Measured in counts timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The number of steps sampled at the time or interval::count type: object required: - unit - timestamp - start - end - value title: ClientFacingStepsTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: count value: 123 ClientFacingStream: properties: cadence: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Cadence description: RPM for cycling, Steps per minute for running default: [] time: anyOf: - items: type: integer type: array - type: 'null' title: Time description: Corresponding time stamp in unix time for datapoint default: [] altitude: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Altitude description: Data points for altitude default: [] velocity_smooth: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Velocity Smooth description: Velocity in m/s default: [] heartrate: anyOf: - items: anyOf: - type: integer - type: 'null' type: array - items: type: integer type: array - type: 'null' title: Heartrate description: Heart rate in bpm default: [] lat: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Lat description: Latitude for data point default: [] lng: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Lng description: Longitude for data point default: [] distance: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Distance description: Cumulated distance for exercise default: [] power: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Power description: Power in watts default: [] resistance: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Resistance description: Resistance on bike default: [] temperature: anyOf: - items: anyOf: - type: number - type: 'null' type: array - items: type: number type: array - type: 'null' title: Temperature description: Temperature stream measured by device in Celsius default: [] type: object title: ClientFacingStream example: altitude: - 10 - 20 - 30 - 40 - 50 cadence: - 10 - 12 - 12 - 11 - 10 distance: - 12 - 15 - 18 - 20 - 25 heartrate: - 120 - 125 - 125 - 130 - 135 lat: - 10 - 20 - 30 - 40 - 50 lng: - 10 - 20 - 30 - 40 - 50 power: - 100 - 100 - 100 - 100 - 100 resistance: - 10 - 20 - 30 - 40 - 50 time: - 1626625123 - 1626625140 - 1626625145 - 1626625150 - 162662560 velocity_smooth: - 10 - 20 - 30 - 40 - 50 ClientFacingStressLevelTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in percentage (0-100). timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value type: object required: - unit - timestamp - value title: ClientFacingStressLevelTimeseries example: timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 35 ClientFacingTeam: properties: id: type: string format: uuid title: Id org_id: type: string format: uuid title: Org Id name: type: string title: Name svix_app_id: anyOf: - type: string - type: 'null' title: Svix App Id client_id: anyOf: - type: string - type: 'null' title: Client Id default: '' client_secret: anyOf: - type: string - type: 'null' title: Client Secret default: '' airtable_api_key: anyOf: - type: string - type: 'null' title: Airtable Api Key default: '' airtable_base_id: anyOf: - type: string - type: 'null' title: Airtable Base Id default: '' webhook_secret: anyOf: - type: string - type: 'null' title: Webhook Secret default: '' api_key: anyOf: - type: string - type: 'null' title: Api Key default: '' api_keys: anyOf: - items: $ref: '#/components/schemas/ClientFacingApiKey' type: array - type: 'null' title: Api Keys configuration: anyOf: - $ref: '#/components/schemas/TeamConfig' - type: 'null' testkits_texts_enabled: type: boolean title: Testkits Texts Enabled deprecated: true lab_tests_patient_communication_enabled: type: boolean title: Lab Tests Patient Communication Enabled lab_tests_patient_sms_communication_enabled: type: boolean title: Lab Tests Patient Sms Communication Enabled lab_tests_patient_email_communication_enabled: type: boolean title: Lab Tests Patient Email Communication Enabled logo_url: anyOf: - type: string - type: 'null' title: Logo Url delegated_flow: $ref: '#/components/schemas/DelegatedFlowType' description: ℹ️ This enum is non-exhaustive. critical_result_notification_email: anyOf: - type: string - type: 'null' title: Critical Result Notification Email type: object required: - id - org_id - name - testkits_texts_enabled - lab_tests_patient_communication_enabled - lab_tests_patient_sms_communication_enabled - lab_tests_patient_email_communication_enabled - delegated_flow title: ClientFacingTeam description: '[Deprecated] GET /v2/team is in the process of being removed. Neither customers nor Dashboard should retrieve team settings and metadata directly. All must migrate to the Team endpoints of the Org Management API.' ClientFacingTestKitOrderDetails: properties: type: type: string const: testkit title: Type data: anyOf: - $ref: '#/components/schemas/ClientFacingTestkitOrder' - type: 'null' type: object required: - type title: ClientFacingTestKitOrderDetails ClientFacingTestkitOrder: properties: id: type: string format: uuid title: Id description: The Vital TestKit Order ID shipment: anyOf: - $ref: '#/components/schemas/ClientFacingShipment' - type: 'null' description: Shipment object created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - shipment - created_at - updated_at title: ClientFacingTestkitOrder description: 'Schema for a testkit order in the client facing API. To be used as part of a ClientFacingOrder.' example: created_at: '2020-01-01T00:00:00Z' id: b31c2663-88de-44b7-977d-c37ef107254f shipment: created_at: '2020-01-01T00:00:00.000Z' id: e56c84fb-f8fa-4d74-bed0-a129b04cb3bc inbound_courier: usps inbound_tracking_number: inbound_tracking_url: notes: outbound_courier: usps outbound_tracking_number: outbound_tracking_url: updated_at: '2020-01-01T00:00:00.000Z' updated_at: '2020-01-01T00:00:00Z' ClientFacingUVExposureSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: index title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingUVExposureSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: index value: 5 ClientFacingUser: properties: user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. team_id: type: string format: uuid title: Team Id description: Your team id. client_user_id: type: string title: Client User Id description: A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. created_on: type: string format: date-time title: Created On description: When your item is created connected_sources: items: $ref: '#/components/schemas/ConnectedSourceClientFacing' type: array title: Connected Sources description: A list of the users connected sources. fallback_time_zone: anyOf: - $ref: '#/components/schemas/FallbackTimeZone' - type: 'null' description: "\n Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London`\ \ or `America/Los_Angeles`).\n Used when pulling data from sources that are completely time zone agnostic (e.g.,\ \ all time is relative to UTC clock, without any time zone attributions on data points).\n " fallback_birth_date: anyOf: - $ref: '#/components/schemas/FallbackBirthDate' - type: 'null' description: Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age. ingestion_start: anyOf: - type: string format: date - type: 'null' title: Ingestion Start description: Starting bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). ingestion_end: anyOf: - type: string format: date - type: 'null' title: Ingestion End description: Ending bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). type: object required: - user_id - team_id - client_user_id - created_on - connected_sources - fallback_time_zone title: User example: client_user_id: ZTEwZjNjMjctOTI2ZS00M2Vm connected_sources: - created_on: '2026-05-20T13:43:42+00:00' source: logo: logo_url name: Oura slug: oura created_on: '2026-05-20T13:43:42+00:00' fallback_birth_date: source_slug: manual updated_at: '2026-05-20T13:43:42+00:00' value: '1989-09-12' fallback_time_zone: id: Europe/London source_slug: manual updated_at: '2026-05-20T13:43:42+00:00' team_id: 56bd81c9-6219-4000-a775-ae85526eba18 user_id: 56bd81c9-6219-4000-a775-ae85526eba18 ClientFacingVO2MaxTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in mL/kg/min. timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingVO2MaxTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: mL/kg/min value: 48 ClientFacingWaistCircumferenceSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: cm title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingWaistCircumferenceSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: cm value: 90 ClientFacingWalkInOrderDetails: properties: type: type: string const: walk_in_test title: Type data: anyOf: - $ref: '#/components/schemas/ClientFacingWalkInTestOrder' - type: 'null' type: object required: - type title: ClientFacingWalkInOrderDetails ClientFacingWalkInTestOrder: properties: id: type: string format: uuid title: Id description: The Vital walk-in test Order ID created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At appointment_id: anyOf: - type: string format: uuid - type: 'null' title: Appointment Id type: object required: - id - created_at - updated_at title: ClientFacingWalkInTestOrder description: 'Schema for a walk-in test order in the client facing API. To be used as part of a ClientFacingOrder.' example: appointment_id: 961495c2-aa74-43ac-bd7d-4284b46499bf created_at: '2020-01-01T00:00:00Z' id: 757df2fd-8ff1-4399-bc48-c37527d9d73a updated_at: '2020-01-01T00:00:00Z' ClientFacingWaterTimeseries: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string title: Unit description: Measured in milliters. timestamp: type: string format: date-time title: Timestamp description: The timestamp of the measurement. value: type: number title: Value description: Quantity of water drank during the time period. type: object required: - unit - timestamp - value title: ClientFacingWaterTimeseries example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: ml value: 400 ClientFacingWheelchairPushSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingWheelchairPushSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 52 ClientFacingWorkout: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. title: anyOf: - type: string - type: 'null' title: Title description: Title given for the workout timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Timezone offset from UTC as seconds. For example, EEST (Eastern European Summer Time, +3h) is 10800. PST (Pacific Standard Time, -8h) is -28800::seconds average_hr: anyOf: - type: integer - type: 'null' title: Average Hr description: Average heart rate during workout::bpm max_hr: anyOf: - type: integer - type: 'null' title: Max Hr description: Max heart rate during workout::bpm distance: anyOf: - type: number - type: 'null' title: Distance description: Distance travelled during workout::meters calendar_date: type: string format: date title: Calendar Date description: Date of the workout summary in the YYYY-mm-dd format. This generally matches the workout start date. time_start: type: string format: date-time title: Time Start description: Start time of the workout::time time_end: type: string format: date-time title: Time End description: End time of the workout::time calories: anyOf: - type: number - type: 'null' title: Calories description: Calories burned during the workout::kCal sport: $ref: '#/components/schemas/ClientFacingSport' description: Sport's name default: '' hr_zones: anyOf: - items: type: integer type: array - type: 'null' title: Hr Zones description: Time in seconds spent in different heart rate zones <50%, 50-60%, 60-70%, 70-80%, 80-90%, 90%+. Due to rounding errors, it's possible that summing all values is different than the total time of the workout. Not available for all providers::seconds moving_time: anyOf: - type: integer - type: 'null' title: Moving Time description: Time spent active during the workout::seconds total_elevation_gain: anyOf: - type: number - type: 'null' title: Total Elevation Gain description: Elevation gain during the workout::meters elev_high: anyOf: - type: number - type: 'null' title: Elev High description: Highest point of elevation::meters elev_low: anyOf: - type: number - type: 'null' title: Elev Low description: Lowest point of elevation::meters average_speed: anyOf: - type: number - type: 'null' title: Average Speed description: Average speed during workout in m/s::meters/sec max_speed: anyOf: - type: number - type: 'null' title: Max Speed description: Max speed during workout in m/s::meters/sec average_watts: anyOf: - type: number - type: 'null' title: Average Watts description: Average watts burned during exercise::watts device_watts: anyOf: - type: number - type: 'null' title: Device Watts description: Watts burned during exercise::watts max_watts: anyOf: - type: number - type: 'null' title: Max Watts description: Max watts burned during exercise::watts weighted_average_watts: anyOf: - type: number - type: 'null' title: Weighted Average Watts description: Weighted average watts burned during exercise::watts steps: anyOf: - type: integer - type: 'null' title: Steps description: Number of steps accumulated during this workout::count map: anyOf: - $ref: '#/components/schemas/ClientFacingWorkoutMap' - type: 'null' description: Map of the workout provider_id: type: string title: Provider Id description: Provider ID given for that specific workout source: $ref: '#/components/schemas/ClientFacingSource' description: Source the data has come from. created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - id - user_id - calendar_date - time_start - time_end - provider_id - source - created_at - updated_at title: Workout Data example: average_hr: 100 average_speed: 4.2 average_watts: 100 calendar_date: '2023-02-27' calories: 300 created_at: '2023-02-27T20:31:24+00:00' device_watts: 80 distance: 1700 elev_high: 20.2 elev_low: -10.2 hr_zones: - 100 - 90 - 10 - 10 - 200 id: 185d0f34-dfc0-429f-84f9-b24030914bdd map: summary_polyline: agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@ max_hr: 190 max_speed: 7.8 max_watts: 200 moving_time: 100 source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: strava type: unknown sport: id: 1 name: football time_end: '2023-02-27T12:31:24+00:00' time_start: '2023-02-27T11:31:24+00:00' total_elevation_gain: 10 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 weighted_average_watts: 250 ClientFacingWorkoutDistanceSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: m title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingWorkoutDistanceSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: m value: 37 ClientFacingWorkoutDurationSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: min title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. intensity: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Intensity description: Workout intensity. ℹ️ This enum is non-exhaustive. type: object required: - unit - timestamp - start - end - value - intensity title: ClientFacingWorkoutDurationSample example: end: '2023-02-13T14:30:52+00:00' intensity: medium start: '2023-02-13T14:30:52+00:00' unit: min value: 48 ClientFacingWorkoutMap: properties: polyline: anyOf: - type: string - type: 'null' title: Polyline description: Polyline of the map summary_polyline: anyOf: - type: string - type: 'null' title: Summary Polyline description: A lower resolution summary of the polyline type: object title: ClientFacingWorkoutMap ClientFacingWorkoutSwimmingStrokeSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: count title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. type: object required: - unit - timestamp - start - end - value title: ClientFacingWorkoutSwimmingStrokeSample example: end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 37 ClientSleepCycleResponse: properties: sleep_cycle: items: $ref: '#/components/schemas/ClientFacingSleepCycle' type: array title: Sleep Cycle type: object required: - sleep_cycle title: Sleep Cycle Data example: sleep_cycle: - created_at: '2023-02-27T20:31:24+00:00' id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b session_end: '2022-01-01T08:00:00' session_start: '2022-01-01T00:00:00' sleep_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: oura type: ring source_provider: oura source_type: ring stage_end_offset_second: - 300 - 600 - 900 - 1200 stage_start_offset_second: - 0 - 300 - 600 - 900 stage_type: - 1 - 2 - 3 - 1 time_zone: America/Los_Angeles updated_at: '2023-02-28T01:22:38+00:00' user_id: f1b3b3b3-1b3b-1b3b-1b3b-1b3b3b3b3b3b ClientSleepResponse: properties: sleep: items: $ref: '#/components/schemas/ClientFacingSleep' type: array title: Sleep type: object required: - sleep title: Sleep Data example: sleep: - average_hrv: 78 awake: 2400 bedtime_start: '2023-02-27T12:31:24+00:00' bedtime_stop: '2023-02-27T12:31:24+00:00' calendar_date: '2023-02-27' created_at: '2023-02-27T20:31:24+00:00' date: '2023-02-27T12:31:24+00:00' deep: 2400 duration: 28800 efficiency: 0.97 hr_average: 50 hr_lowest: 43 id: e2e0eb04-6641-4858-9de5-649efb41b346 latency: 1000 light: 2400 recovery_readiness_score: 82 rem: 2400 respiratory_rate: 14 skin_temperature: 36.5 source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: oura type: unknown temperature_delta: -0.2 timezone_offset: 2400 total: 28800 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientUserIDConflict: properties: error_type: type: string title: Error Type error_message: type: string title: Error Message user_id: type: string format: uuid title: User Id created_on: type: string format: date-time title: Created On type: object required: - error_type - error_message - user_id - created_on title: ClientUserIDConflict ClientUserIDConflictResponse: properties: detail: $ref: '#/components/schemas/ClientUserIDConflict' type: object required: - detail title: ClientUserIDConflictResponse example: detail: created_on: '2023-02-27T12:31:24+00:00' error_message: Client user id already exists. error_type: INVALID_REQUEST user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ClientWorkoutResponse: properties: workouts: items: $ref: '#/components/schemas/ClientFacingWorkout' type: array title: Workouts type: object required: - workouts title: ClientWorkoutResponse example: workouts: - average_hr: 100 average_speed: 4.2 average_watts: 100 calendar_date: '2023-02-27' calories: 300 created_at: '2023-02-27T20:31:24+00:00' device_watts: 80 distance: 1700 elev_high: 20.2 elev_low: -10.2 hr_zones: - 100 - 90 - 10 - 10 - 200 id: 185d0f34-dfc0-429f-84f9-b24030914bdd map: summary_polyline: agn~Ftb{uOvr@daBunBjdBkHwiD????~Ngn@ha@_N~Ql`@ max_hr: 190 max_speed: 7.8 max_watts: 200 moving_time: 100 source: device_id: 550e8400-e29b-41d4-a716-446655440000 provider: strava type: unknown sport: id: 1 name: football time_end: '2023-02-27T12:31:24+00:00' time_start: '2023-02-27T11:31:24+00:00' total_elevation_gain: 10 updated_at: '2023-02-28T01:22:38+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 weighted_average_watts: 250 ClinicalInformation: properties: fasting: type: boolean title: Fasting default: false notes: anyOf: - type: string - type: 'null' title: Notes information: anyOf: - type: string - type: 'null' title: Information total_volume: anyOf: - type: string - type: 'null' title: Total Volume type: object title: ClinicalInformation CompanyDetails: properties: name: type: string title: Name address: $ref: '#/components/schemas/Address' type: object required: - name - address title: CompanyDetails CompendiumSearchLabs: type: string enum: - labcorp - quest - bioreference - sonora_quest title: CompendiumSearchLabs description: ℹ️ This enum is non-exhaustive. CompletePasswordProviderMFABody: properties: mfa_code: type: string title: Mfa Code type: object required: - mfa_code title: CompletePasswordProviderMFABody ConnectedSourceClientFacing: properties: provider: $ref: '#/components/schemas/ClientFacingProvider' description: The provider of this connected source. created_on: type: string format: date-time title: Created On description: When your item is created source: $ref: '#/components/schemas/ClientFacingProvider' description: Deprecated. Use `provider` instead. Subject to removal after 1 Jan 2024. deprecated: true type: object required: - provider - created_on - source title: ConnectedSourceClientFacing ConnectionRecipe: properties: user_id: type: string format: uuid title: User Id description: Vital User ID. The user must be created ahead of the bulk import operation. access_token: type: string title: Access Token description: '* OAuth 2.0 providers (Fitbit, etc): The latest Access Token. * OAuth 1.0 providers (Garmin): The Access Token.' refresh_token: type: string title: Refresh Token description: '* OAuth 2.0 providers (Fitbit, etc): The latest Refresh Token. * OAuth 1.0 providers (Garmin): The Token Secret.' provider_id: type: string title: Provider Id description: "User ID of the data provider.\n\n* Fitbit: 6-character Fitbit User ID \n* Garmin: 36-character Garmin\ \ User ID" expires_at: type: integer title: Expires At description: 'Access token expiry date, in terms of UNIX epoch seconds. * OAuth 2.0 providers (Fitbit, etc): The latest expiry date on your record. * OAuth 1.0 providers (Garmin): Use the constant value `2147483647`.' oauth_scopes: anyOf: - items: type: string type: array - type: 'null' title: Oauth Scopes description: 'OAuth scopes of the data provider. Specify `null` if you do not have any scopes on record. * Fitbit: Has scopes * Garmin: No scope' type: object required: - user_id - access_token - refresh_token - provider_id - expires_at title: ConnectionRecipe Consent: properties: consentType: $ref: '#/components/schemas/ConsentType' description: ℹ️ This enum is non-exhaustive. version: type: string title: Version default: '1.0' timeOfConsent: type: string format: date-time title: Timeofconsent type: object required: - consentType title: Consent ConsentType: type: string enum: - terms-of-use - telehealth-informed-consent - mobile-terms-and-conditions - notice-of-privacy-practices - privacy-policy - hipaa-authorization title: ConsentType description: ℹ️ This enum is non-exhaustive. ContinuousQueryResultTableChanges: properties: query_id: type: string format: uuid title: Query Id query_slug: type: string title: Query Slug data: additionalProperties: items: {} type: array type: object title: Data type: object required: - query_id - query_slug - data title: ContinuousQueryResultTableChanges example: data: group_key.0: - '2025-02-17T00:00:00' mean.efficiency: - 98.22 mean.sleep_score: - 76.75 min.sleep_score: - 61 newest.chronotype: - third query_id: 3d459f48-a736-476a-8714-95aa3b2b3708 query_slug: sleep-analysis-v1 ContinuousQueryTaskHistoryEntry: properties: query_id: type: string format: uuid title: Query Id user_id: type: string format: uuid title: User Id status: $ref: '#/components/schemas/ContinuousQueryTaskStatus' description: ℹ️ This enum is non-exhaustive. scheduled_at: type: string format: date-time title: Scheduled At started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At error_details: anyOf: - type: string - type: 'null' title: Error Details type: object required: - query_id - user_id - status - scheduled_at - started_at - ended_at - error_details title: ContinuousQueryTaskHistoryEntry ContinuousQueryTaskHistoryResponse: properties: data: items: $ref: '#/components/schemas/ContinuousQueryTaskHistoryEntry' type: array title: Data next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor type: object required: - data - next_cursor title: ContinuousQueryTaskHistoryResponse ContinuousQueryTaskStatus: type: string enum: - scheduled - started - completed - error - skipped title: ContinuousQueryTaskStatus description: ℹ️ This enum is non-exhaustive. ContraceptiveEntry: properties: date: type: string format: date title: Date type: type: string enum: - unspecified - implant - injection - iud - intravaginal_ring - oral - patch title: Type description: ℹ️ This enum is non-exhaustive. type: object required: - date - type title: ContraceptiveEntry ConvertCompendiumBody: properties: lab_test_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Test Id provider_ids: anyOf: - items: type: string type: array - type: 'null' title: Provider Ids target_lab: $ref: '#/components/schemas/CompendiumSearchLabs' description: ℹ️ This enum is non-exhaustive. limit: type: integer title: Limit default: 3 type: object required: - target_lab title: ConvertCompendiumBody ConvertCompendiumResponse: properties: source_lab_test_id: anyOf: - type: string format: uuid - type: 'null' title: Source Lab Test Id source_lab_id: anyOf: - type: integer - type: 'null' title: Source Lab Id target_lab_id: type: integer title: Target Lab Id target_lab_slug: type: string title: Target Lab Slug source_provider_ids: items: type: string type: array title: Source Provider Ids converted_provider_ids: items: type: string type: array title: Converted Provider Ids unresolved_provider_ids: items: type: string type: array title: Unresolved Provider Ids by_source_provider_id: additionalProperties: $ref: '#/components/schemas/ProviderIdConversionResponse' type: object title: By Source Provider Id type: object required: - target_lab_id - target_lab_slug title: ConvertCompendiumResponse CreateInsuranceRequest: properties: payor_code: type: string title: Payor Code member_id: type: string title: Member Id group_id: anyOf: - type: string - type: 'null' title: Group Id relationship: $ref: '#/components/schemas/ResponsibleRelationship' description: ℹ️ This enum is non-exhaustive. insured: $ref: '#/components/schemas/vital_core__schemas__db_schemas__lab_test__insurance__PersonDetails' guarantor: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' is_primary: type: boolean title: Is Primary default: true type: object required: - payor_code - member_id - relationship - insured title: CreateInsuranceRequest CreateLabReportParserJobBody: properties: file: items: type: string format: binary type: array title: File user_id: type: string format: uuid title: User Id needs_human_review: type: boolean title: Needs Human Review default: false type: object required: - file - user_id title: CreateLabReportParserJobBody CreateLabTestRequest: properties: marker_ids: anyOf: - items: type: integer type: array - type: 'null' title: Marker Ids provider_ids: anyOf: - items: type: string type: array - type: 'null' title: Provider Ids name: type: string title: Name method: $ref: '#/components/schemas/LabTestCollectionMethod' description: ℹ️ This enum is non-exhaustive. description: type: string title: Description fasting: anyOf: - type: boolean - type: 'null' title: Fasting default: false lab_account_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Account Id lab_slug: anyOf: - $ref: '#/components/schemas/Labs' - type: 'null' description: ℹ️ This enum is non-exhaustive. type: object required: - name - method - description title: CreateLabTestRequest CreateOrderRequestCompatible: properties: user_id: type: string format: uuid title: User Id lab_test_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Test Id deprecated: true order_set: anyOf: - $ref: '#/components/schemas/OrderSetRequest' - type: 'null' collection_method: anyOf: - $ref: '#/components/schemas/LabTestCollectionMethod' - type: 'null' description: ℹ️ This enum is non-exhaustive. physician: anyOf: - $ref: '#/components/schemas/PhysicianCreateRequest' - type: 'null' health_insurance: anyOf: - $ref: '#/components/schemas/HealthInsuranceCreateRequest' - type: 'null' deprecated: true priority: type: boolean title: Priority description: Defines whether order is priority or not. For some labs, this refers to a STAT order. default: false billing_type: $ref: '#/components/schemas/Billing' default: client_bill description: ℹ️ This enum is non-exhaustive. icd_codes: anyOf: - items: type: string type: array - type: 'null' title: Icd Codes consents: items: $ref: '#/components/schemas/Consent' type: array title: Consents activate_by: anyOf: - type: string format: date - type: 'null' title: Activate By description: Schedule an Order to be processed in a future date. aoe_answers: anyOf: - items: $ref: '#/components/schemas/AoEAnswer' type: array - type: 'null' title: Aoe Answers passthrough: anyOf: - type: string - type: 'null' title: Passthrough clinical_notes: anyOf: - type: string - type: 'null' title: Clinical Notes lab_account_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Account Id creator_member_id: anyOf: - type: string format: uuid - type: 'null' title: Creator Member Id patient_details: $ref: '#/components/schemas/PatientDetailsWithValidation' patient_address: $ref: '#/components/schemas/PatientAddressWithValidation' type: object required: - user_id - patient_details - patient_address title: CreateOrderRequestCompatible description: Schema for the create Order endpoint. CreatePayorBody: properties: name: type: string title: Name address: $ref: '#/components/schemas/Address' provider: anyOf: - $ref: '#/components/schemas/PayorCodeExternalProvider' - type: 'null' description: ℹ️ This enum is non-exhaustive. provider_payor_id: anyOf: - type: string - type: 'null' title: Provider Payor Id type: object required: - name - address title: CreatePayorBody CreateRegistrableTestkitOrderRequest: properties: user_id: type: string format: uuid title: User Id lab_test_id: type: string format: uuid title: Lab Test Id shipping_details: $ref: '#/components/schemas/ShippingAddressWithValidation' passthrough: anyOf: - type: string - type: 'null' title: Passthrough lab_account_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Account Id type: object required: - user_id - lab_test_id - shipping_details title: CreateRegistrableTestkitOrderRequest CreateUserPortalURLBody: properties: context: type: string enum: - launch - communications title: Context description: '`launch`: Generates a short-lived (minutes) portal URL that is intended for launching a user from your authenticated web context directly into the Junction User Portal. This URL is not suitable for asynchronous communications due to its verbosity as well as short-lived nature. `communications`: Generates a long-lived (weeks) but shortened portal URL that is suitable for Emails, SMS messages and other communication channels. Users may be asked to verify their identity with Email and SMS authentication, e.g., when they open a short link on a new device. ℹ️ This enum is non-exhaustive.' order_id: anyOf: - type: string format: uuid - type: 'null' title: Order Id description: If specified, the generated URL will deeplink to the specified Order. type: object required: - context title: CreateUserPortalURLBody CreateUserPortalURLResponse: properties: url: type: string title: Url expires_in: type: integer title: Expires In type: object required: - url - expires_in title: CreateUserPortalURLResponse DatePartExpr: properties: arg: anyOf: - $ref: '#/components/schemas/IndexColumnExpr' - $ref: '#/components/schemas/Placeholder' title: Arg date_part: anyOf: - type: string enum: - minute - hour - day - week - month - year - type: string enum: - weekday - week_of_year - day_of_year title: Date Part description: ℹ️ This enum is non-exhaustive. type: object required: - arg - date_part title: DatePartExpr DateTruncExpr: properties: date_trunc: $ref: '#/components/schemas/Period' arg: anyOf: - $ref: '#/components/schemas/IndexColumnExpr' - $ref: '#/components/schemas/Placeholder' title: Arg type: object required: - date_trunc - arg title: DateTruncExpr DaySlots: properties: location: anyOf: - $ref: '#/components/schemas/AppointmentLocation' - type: 'null' date: type: string format: date title: Date slots: items: $ref: '#/components/schemas/TimeSlot' type: array title: Slots type: object required: - date - slots title: DaySlots DelegatedFlowType: type: string enum: - order_and_results_with_customer_physician_network - order_with_vital_physician_network - order_and_results_with_vital_physician_network title: DelegatedFlowType description: ℹ️ This enum is non-exhaustive. DemoConnectionCreationPayload: properties: user_id: type: string format: uuid4 title: User Id description: Vital user ID provider: $ref: '#/components/schemas/DemoProviders' description: Demo provider. For more information, please check out our docs (https://docs.tryvital.io/wearables/providers/test_data) ℹ️ This enum is non-exhaustive. type: object required: - user_id - provider title: DemoConnectionCreationPayload DemoConnectionStatus: properties: success: type: boolean title: Success detail: type: string title: Detail type: object required: - success - detail title: DemoConnectionStatus example: detail: Connected user 37c9c3fa-49e8-4d60-8cc8-328cba420f30 to provider fitbit success: true DemoProviders: type: string enum: - apple_health_kit - fitbit - freestyle_libre - oura title: DemoProviders description: ℹ️ This enum is non-exhaustive. DerivedReadinessColumnExpr: properties: derived_readiness: type: string enum: - date - chronotype - sleep_score - recovery_score - recovery_zone - stress_score - strain_score - strain_zone title: Derived Readiness description: ℹ️ This enum is non-exhaustive. type: object required: - derived_readiness title: DerivedReadinessColumnExpr DetectedDeviationEntry: properties: date: type: string format: date title: Date deviation: type: string enum: - persistent_intermenstrual_bleeding - prolonged_menstrual_periods - irregular_menstrual_cycles - infrequent_menstrual_cycles title: Deviation description: ℹ️ This enum is non-exhaustive. type: object required: - date - deviation title: DetectedDeviationEntry DiscreteTimeseriesExpr: properties: timeseries: type: string enum: - glucose - heartrate - hrv - ige - igg - cholesterol - weight - fat - blood_oxygen - electrocardiogram_voltage - respiratory_rate - stress_level title: Timeseries description: ℹ️ This enum is non-exhaustive. field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string const: value title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: DiscreteTimeseriesExpr ElementFieldExpr: properties: element: type: boolean const: true title: Element additionalProperties: false type: object required: - element title: ElementFieldExpr description: 'References the element itself in a scalar-element list subquery arg. Symmetric with the reserved ``element`` keyword in WHERE predicates. Only valid when the UNNEST source is a ``List[scalar]``.' EmailProviderAuthLink: properties: email: type: string title: Email provider: anyOf: - $ref: '#/components/schemas/Providers' - type: 'null' deprecated: true description: ℹ️ This enum is non-exhaustive. region: $ref: '#/components/schemas/Region' description: ℹ️ This enum is non-exhaustive. type: object required: - email title: EmailProviderAuthLink EmailProviders: type: string enum: - freestyle_libre title: EmailProviders description: ℹ️ This enum is non-exhaustive. Energy: properties: unit: type: string const: kcal title: Unit value: type: number title: Value type: object required: - unit - value title: Energy Ethnicity: type: string enum: - hispanic - non_hispanic - ashkenazi_jewish - other title: Ethnicity description: ℹ️ This enum is non-exhaustive. EventDestinationPreferences: properties: preferred: type: string enum: - cloud_pubsub - rabbitmq - svix - azure_amqp title: Preferred description: ℹ️ This enum is non-exhaustive. enabled: items: type: string enum: - cloud_pubsub - rabbitmq - svix - azure_amqp type: array title: Enabled type: object required: - preferred - enabled title: EventDestinationPreferences FailureType: type: string enum: - quantity_not_sufficient_failure - collection_process_failure - drop_off_failure - internal_lab_failure - order_entry_failure - non_failure - unknown_failure - patient_condition_failure - missing_result_calc_failure - missing_demo_aoe_calc_failure - insufficient_volume title: FailureType description: ℹ️ This enum is non-exhaustive. FallbackBirthDate: properties: value: type: string format: date title: Value description: Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age. source_slug: type: string title: Source Slug description: Slug for designated source updated_at: type: string format: date-time title: Updated At type: object required: - value - source_slug - updated_at title: FallbackBirthDate FallbackTimeZone: properties: id: type: string title: Id description: "\n Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London`\ \ or `America/Los_Angeles`).\n Used when pulling data from sources that are completely time zone agnostic (e.g.,\ \ all time is relative to UTC clock, without any time zone attributions on data points).\n " source_slug: type: string title: Source Slug description: Slug for designated source updated_at: type: string format: date-time title: Updated At type: object required: - id - source_slug - updated_at title: FallbackTimeZone Fats: properties: saturated: anyOf: - type: number - type: 'null' title: Saturated description: Amount of saturated fats in grams (g) monounsaturated: anyOf: - type: number - type: 'null' title: Monounsaturated description: Amount of monounsaturated fats in grams (g) polyunsaturated: anyOf: - type: number - type: 'null' title: Polyunsaturated description: Amount of polyunsaturated fats in grams (g) omega3: anyOf: - type: number - type: 'null' title: Omega3 description: Amount of Omega-3 fatty acids in grams (g) omega6: anyOf: - type: number - type: 'null' title: Omega6 description: Amount of Omega-6 fatty acids in grams (g) total: anyOf: - type: number - type: 'null' title: Total description: Total amount of fats in grams (g) type: object title: Fats Gender: type: string enum: - female - male - other - unknown title: Gender description: ℹ️ This enum is non-exhaustive. GenderIdentity: type: string enum: - male - female - female_to_male_ftm_transgender_male_trans_man - male_to_female_mtf_transgender_female_trans_woman - genderqueer - other title: GenderIdentity description: ℹ️ This enum is non-exhaustive. GetMarkersResponse: properties: markers: items: $ref: '#/components/schemas/ClientFacingMarkerComplete' type: array title: Markers total: anyOf: - type: integer minimum: 0 - type: 'null' title: Total page: anyOf: - type: integer minimum: 0 - type: 'null' title: Page size: anyOf: - type: integer minimum: 0 - type: 'null' title: Size pages: anyOf: - type: integer minimum: 0 - type: 'null' title: Pages type: object required: - markers - total - page - size - pages title: GetMarkersResponse GetOrderTransactionResponse: properties: id: type: string format: uuid title: Id team_id: type: string format: uuid title: Team Id status: $ref: '#/components/schemas/OrderTransactionStatus' description: ℹ️ This enum is non-exhaustive. orders: items: $ref: '#/components/schemas/OrderSummary' type: array title: Orders type: object required: - id - team_id - status title: GetOrderTransactionResponse GetOrdersResponse: properties: orders: items: $ref: '#/components/schemas/ClientFacingOrder' type: array title: Orders total: anyOf: - type: integer - type: 'null' title: Total page: anyOf: - type: integer - type: 'null' title: Page size: anyOf: - type: integer - type: 'null' title: Size type: object required: - orders title: GetOrdersResponse GetTeamLabAccountsResponse: properties: data: items: $ref: '#/components/schemas/ClientFacingLabAccount' type: array title: Data type: object title: GetTeamLabAccountsResponse GroupKeyColumnExpr: properties: group_key: anyOf: - type: integer - type: string const: '*' title: Group Key type: object required: - group_key title: GroupKeyColumnExpr GuarantorDetails: properties: first_name: type: string title: First Name last_name: type: string title: Last Name address: $ref: '#/components/schemas/Address' phone_number: type: string title: Phone Number household_income: anyOf: - type: integer - type: 'null' title: Household Income household_size: anyOf: - type: integer - type: 'null' title: Household Size email: anyOf: - type: string - type: 'null' title: Email type: object required: - first_name - last_name - address - phone_number title: GuarantorDetails HTTPValidationError: properties: detail: title: Detail type: object title: HTTPValidationError HealthInsuranceCreateRequest: properties: front_image: anyOf: - $ref: '#/components/schemas/Jpeg' - $ref: '#/components/schemas/Png' - type: 'null' title: Front Image description: An image of the front of the patient insurance card. back_image: anyOf: - $ref: '#/components/schemas/Jpeg' - $ref: '#/components/schemas/Png' - type: 'null' title: Back Image description: An image of the back of the patient insurance card. patient_signature_image: anyOf: - $ref: '#/components/schemas/Jpeg' - $ref: '#/components/schemas/Png' - type: 'null' title: Patient Signature Image description: An image of the patient signature for health insurance billing. subjective: anyOf: - type: string - type: 'null' title: Subjective description: Textual description of what are the patient symptoms and attempted treatments. assessment_plan: anyOf: - type: string - type: 'null' title: Assessment Plan description: Textual description of what are the physician assessments and testing plans. payor_code: anyOf: - type: string - type: 'null' title: Payor Code description: Unique identifier representing a specific Health Insurance. insurance_id: anyOf: - type: string - type: 'null' title: Insurance Id description: Insurance unique number assigned to a patient, usually present on the insurance card. responsible_relationship: anyOf: - $ref: '#/components/schemas/ResponsibleRelationship' - type: 'null' description: Relationship between the patient and the insurance contractor. Values can be (Self, Spouse, Other Relationship). ℹ️ This enum is non-exhaustive. responsible_details: anyOf: - $ref: '#/components/schemas/vital_core__schemas__db_schemas__lab_test__health_insurance__PersonDetails' - type: 'null' description: Responsible details when the value of responsible_relationship is not 'Self'. diagnosis_codes: anyOf: - items: type: string type: array - type: 'null' title: Diagnosis Codes description: Diagnosis codes for insurance billing. type: object title: HealthInsuranceCreateRequest HistoricalPullCompleted: properties: user_id: type: string format: uuid title: User Id start_date: type: string format: date-time title: Start Date end_date: type: string format: date-time title: End Date is_final: type: boolean const: true title: Is Final provider: type: string title: Provider type: object required: - user_id - start_date - end_date - is_final - provider title: HistoricalPullCompleted HistoricalPullNonRetriableErrorDetails: type: string enum: - non_retriable_error - unexpected_error - retry_quota_exhausted title: HistoricalPullNonRetriableErrorDetails description: ℹ️ This enum is non-exhaustive. HistoricalPullRetriableErrorDetails: type: string enum: - provider_rate_limit_exceeded - provider_unavailable - transport_failure - resource_contention title: HistoricalPullRetriableErrorDetails description: ℹ️ This enum is non-exhaustive. HistoricalPullStatus: type: string enum: - success - failure - in_progress - scheduled - retrying title: HistoricalPullStatus description: ℹ️ This enum is non-exhaustive. HistoricalPullTimeline: properties: scheduled_at: type: string format: date-time title: Scheduled At started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At type: object required: - scheduled_at title: HistoricalPullTimeline HomePregnancyTestEntry: properties: date: type: string format: date title: Date test_result: type: string enum: - negative - positive - indeterminate title: Test Result description: ℹ️ This enum is non-exhaustive. type: object required: - date - test_result title: HomePregnancyTestEntry HomeProgesteroneTestEntry: properties: date: type: string format: date title: Date test_result: type: string enum: - negative - positive - indeterminate title: Test Result description: ℹ️ This enum is non-exhaustive. type: object required: - date - test_result title: HomeProgesteroneTestEntry ICDExcludesViolation: properties: code: type: string title: Code conflicts_with: type: string title: Conflicts With type: type: string title: Type type: object required: - code - conflicts_with - type title: ICDExcludesViolation ICDExcludesWarning: properties: code: type: string title: Code overlaps_with: type: string title: Overlaps With type: type: string title: Type type: object required: - code - overlaps_with - type title: ICDExcludesWarning ImportOrderBody: properties: user_id: type: string format: uuid title: User Id billing_type: $ref: '#/components/schemas/Billing' description: ℹ️ This enum is non-exhaustive. order_set: $ref: '#/components/schemas/OrderSetRequest' collection_method: $ref: '#/components/schemas/LabTestCollectionMethod' description: ℹ️ This enum is non-exhaustive. physician: anyOf: - $ref: '#/components/schemas/PhysicianCreateRequest' - type: 'null' patient_details: $ref: '#/components/schemas/PatientDetailsWithValidation' patient_address: $ref: '#/components/schemas/PatientAddress' sample_id: type: string title: Sample Id lab_account_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Account Id type: object required: - user_id - billing_type - order_set - collection_method - patient_details - patient_address - sample_id title: ImportOrderBody IndexColumnExpr: properties: index: type: string enum: - sleep - derived_readiness - activity - workout - body - meal - menstrual_cycle - profile - timeseries title: Index description: ℹ️ This enum is non-exhaustive. type: object required: - index title: IndexColumnExpr IndividualProviderData: properties: username: type: string title: Username description: Username for provider password: type: string title: Password description: Password for provider region: anyOf: - $ref: '#/components/schemas/Region' - type: 'null' description: Provider region to authenticate against. Only applicable to specific providers. ℹ️ This enum is non-exhaustive. type: object required: - username - password title: IndividualProviderData InsulinInjectionTimeseriesExpr: properties: timeseries: type: string const: insulin_injection title: Timeseries field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - duration - value - type: string enum: - delivery_mode - delivery_form - bolus_purpose title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: InsulinInjectionTimeseriesExpr IntermenstrualBleedingEntry: properties: date: type: string format: date title: Date type: object required: - date title: IntermenstrualBleedingEntry Interpretation: type: string enum: - normal - abnormal - critical - unknown title: Interpretation description: ℹ️ This enum is non-exhaustive. IntervalTimeseriesExpr: properties: timeseries: type: string enum: - steps - distance - vo2_max - heart_rate_alert - stand_hour - sleep_breathing_disturbance - water - caffeine - mindfulness_minutes - calories_active - floors_climbed - calories_basal - afib_burden - stand_duration - sleep_apnea_alert - wheelchair_push - forced_expiratory_volume_1 - forced_vital_capacity - peak_expiratory_flow_rate - inhaler_usage - fall - uv_exposure - daylight_exposure - handwashing - basal_body_temperature - body_mass_index - lean_body_mass - waist_circumference - heart_rate_recovery_one_minute - workout_swimming_stroke - workout_distance - carbohydrates title: Timeseries description: ℹ️ This enum is non-exhaustive. field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - duration - value title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: IntervalTimeseriesExpr Jpeg: properties: content: type: string title: Content format: binary content_type: type: string const: image/jpeg title: Content Type type: object required: - content - content_type title: Jpeg LabAccountDelegatedFlow: type: string enum: - order_delegated - result_delegated - fully_delegated - not_delegated title: LabAccountDelegatedFlow description: 'Describes which parts of the lab testing flow are delegated to the customer. - ORDER_DELEGATED: Ordering using client''s physicians, critical result follow up via Junction - RESULT_DELEGATED: Ordering using Junction''s Physician Network, critical results handled by client - FULLY_DELEGATED: Order and critical results handled by client - NOT_DELEGATED: Junction handles both ordering and results ℹ️ This enum is non-exhaustive.' LabAccountStatus: type: string enum: - active - pending - suspended - ready_to_launch title: LabAccountStatus description: ℹ️ This enum is non-exhaustive. LabLocationCapability: type: string enum: - stat - appointment_scheduling_via_junction - appointment_scheduling_with_lab title: LabLocationCapability description: ℹ️ This enum is non-exhaustive. LabLocationMetadata: properties: name: type: string title: Name state: type: string title: State city: type: string title: City zip_code: type: string title: Zip Code first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line phone_number: anyOf: - type: string - type: 'null' title: Phone Number fax_number: anyOf: - type: string - type: 'null' title: Fax Number hours: anyOf: - additionalProperties: true type: object - type: 'null' title: Hours type: object required: - name - state - city - zip_code - first_line title: LabLocationMetadata LabReportResult: properties: test_name: type: string title: Test Name value: type: string title: Value sample_type: type: string enum: - urine - serum_plasma_blood - capillary_blood - stool - saliva - other - unknown title: Sample Type default: unknown description: ℹ️ This enum is non-exhaustive. measurement_kind: type: string enum: - direct - calculated - ratio - unknown title: Measurement Kind default: unknown description: ℹ️ This enum is non-exhaustive. type: anyOf: - $ref: '#/components/schemas/LabReportResultType' - type: 'null' description: ℹ️ This enum is non-exhaustive. units: anyOf: - type: string - type: 'null' title: Units max_reference_range: anyOf: - type: number - type: 'null' title: Max Reference Range min_reference_range: anyOf: - type: number - type: 'null' title: Min Reference Range source_panel_name: anyOf: - type: string - type: 'null' title: Source Panel Name loinc_matches: anyOf: - items: $ref: '#/components/schemas/LoincMatch' type: array - type: 'null' title: Loinc Matches loinc_match_status: anyOf: - type: string enum: - auto_match - needs_review - no_match - type: 'null' title: Loinc Match Status description: ℹ️ This enum is non-exhaustive. interpretation: anyOf: - $ref: '#/components/schemas/Interpretation' - type: 'null' description: ℹ️ This enum is non-exhaustive. is_above_max_range: anyOf: - type: boolean - type: 'null' title: Is Above Max Range is_below_min_range: anyOf: - type: boolean - type: 'null' title: Is Below Min Range type: object required: - test_name - value title: LabReportResult LabReportResultType: type: string enum: - numeric - range - comment - boolean - duration - percentage - ratio title: LabReportResultType description: ℹ️ This enum is non-exhaustive. LabResultsMetadata: properties: age: type: string title: Age dob: type: string title: Dob clia_#: anyOf: - type: string - type: 'null' title: 'Clia #' patient: type: string title: Patient provider: anyOf: - type: string - type: 'null' title: Provider laboratory: anyOf: - type: string - type: 'null' title: Laboratory date_reported: type: string title: Date Reported deprecated: true date_collected: anyOf: - type: string - type: 'null' title: Date Collected deprecated: true specimen_number: type: string title: Specimen Number date_received: anyOf: - type: string - type: 'null' title: Date Received deprecated: true status: type: string title: Status default: final interpretation: anyOf: - type: string - type: 'null' title: Interpretation patient_id: anyOf: - type: string - type: 'null' title: Patient Id account_id: anyOf: - type: string - type: 'null' title: Account Id type: object required: - age - dob - patient - date_reported - specimen_number title: LabResultsMetadata example: age: 19 clia_number: '12331231' date_collected: '2022-02-02' date_received: '2022-01-01' date_reported: '2020-01-01' dob: 18/08/1993 interpretation: normal laboratory: Quest Diagnostics patient: Bob Smith provider: Dr. Jack Smith specimen_number: '123131' status: final LabResultsRaw: properties: metadata: $ref: '#/components/schemas/LabResultsMetadata' results: anyOf: - items: $ref: '#/components/schemas/BiomarkerResult' type: array - additionalProperties: true type: object title: Results missing_results: anyOf: - items: $ref: '#/components/schemas/MissingBiomarkerResult' type: array - type: 'null' title: Missing Results sample_information: anyOf: - additionalProperties: $ref: '#/components/schemas/SampleData' type: object - type: 'null' title: Sample Information order_transaction: anyOf: - $ref: '#/components/schemas/ClientFacingOrderTransaction' - type: 'null' type: object required: - metadata - results title: LabResultsRaw example: metadata: age: 19 clia_number: '12331231' date_collected: '2022-02-02' date_received: '2022-01-01' date_reported: '2020-01-01' dob: 18/08/1993 interpretation: normal laboratory: Quest Diagnostics patient: Bob Smith provider: Dr. Jack Smith specimen_number: '123131' status: final results: '[marker]': {} fsh: {} ige: {} LabTestCollectionMethod: type: string enum: - testkit - walk_in_test - at_home_phlebotomy - on_site_collection title: LabTestCollectionMethod description: The method used to perform a lab test. ℹ️ This enum is non-exhaustive. LabTestGenerationMethodFilter: type: string enum: - auto - manual - all title: LabTestGenerationMethodFilter description: ℹ️ This enum is non-exhaustive. LabTestResourcesResponse: properties: data: items: $ref: '#/components/schemas/ClientFacingLabTest' type: array title: Data next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. type: object required: - data - next_cursor title: LabTestResourcesResponse LabTestSampleType: type: string enum: - dried_blood_spot - arm_collector - serum - saliva - urine - stool title: LabTestSampleType description: The type of sample used to perform a lab test. ℹ️ This enum is non-exhaustive. LabTestStatus: type: string enum: - active - pending_approval - inactive title: LabTestStatus description: ℹ️ This enum is non-exhaustive. Labs: type: string enum: - ayumetrix - spiriplex - ussl - quest - sonora_quest - labcorp - bioreference - us_biotek - manual - sanocardio - ihd - nexus - my_uti - crl title: Labs description: ℹ️ This enum is non-exhaustive. LastAttempt: properties: timestamp: type: string format: date-time title: Timestamp status: $ref: '#/components/schemas/AttemptStatus' description: ℹ️ This enum is non-exhaustive. type: object required: - timestamp - status title: LastAttempt LibreConfig: properties: practice_id: additionalProperties: true type: object title: Practice Id strip_tz: type: boolean title: Strip Tz default: false type: object required: - practice_id title: LibreConfig LinkTokenExchange: properties: user_id: type: string format: uuid title: User Id description: User id returned by vital create user request. This id should be stored in your database against the user and used for all interactions with the vital api. provider: anyOf: - $ref: '#/components/schemas/Providers' - type: 'null' description: ℹ️ This enum is non-exhaustive. redirect_url: anyOf: - type: string - type: 'null' title: Redirect Url filter_on_providers: anyOf: - items: $ref: '#/components/schemas/Providers' type: array minItems: 1 - type: 'null' title: Filter On Providers description: 'An allowlist of providers dictating what Vital Link Widget should show to the end user. If unspecified, all linkable providers are shown. This has no effect on programmatic Vital Link API usage.' on_error: anyOf: - type: string const: redirect - type: 'null' title: On Error description: 'By default, Vital Link Widget input forms for password and email providers have in-built error handling. Specifying `on_error=redirect` disables this Vital Link Widget UI behaviour — it would instead redirect to your `redirect_url`, with Link Error parameters injected. This has no effect on OAuth providers — they always redirect to your `redirect_url`. This also has no effect on programmatic Vital Link API usage.' on_close: anyOf: - type: string const: redirect - type: 'null' title: On Close description: 'By default, Vital Link Widget closes the window or tab when the user taps the Close button. Specifying `on_close=redirect` would change the Close button behaviour to redirect to your `redirect_url` with the `user_cancelled` error specified. This has no effect on programmatic Vital Link API usage.' type: object required: - user_id title: LinkTokenExchange LinkTokenExchangeResponse: properties: link_token: type: string title: Link Token description: A short-lived Vital Link token for your Custom Link Widget to communicate with the Vital API. link_web_url: type: string title: Link Web Url description: The web browser link to launch the default Vital Link experience. If you requested the token for one specific provider, the link would redirect directly to the provider authentication flow. Otherwise, the user would be presented with a list of providers based on your team and token configurations. type: object required: - link_token - link_web_url title: LinkTokenExchangeResponse example: link_token: dGVzdCB0ZXN0IHRlc3Q= link_web_url: https://link.tryvital.io/?token=dGVzdCB0ZXN0IHRlc3Q%3D&env=production®ion=us LngLat: properties: lng: type: number maximum: 180 minimum: -180 title: Lng lat: type: number maximum: 90 minimum: -90 title: Lat type: object required: - lng - lat title: LngLat LoincMatch: properties: loinc_code: type: string title: Loinc Code loinc_name: type: string title: Loinc Name display_name: type: string title: Display Name default: '' aliases: items: type: string type: array title: Aliases default: [] confidence_score: type: number title: Confidence Score type: object required: - loinc_code - loinc_name - confidence_score title: LoincMatch MCBasalBodyTemperatureFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle basal_body_temperature: type: string enum: - date - value title: Basal Body Temperature description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - basal_body_temperature title: MCBasalBodyTemperatureFieldExpr MCCervicalMucusFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle cervical_mucus: type: string enum: - date - quality title: Cervical Mucus description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - cervical_mucus title: MCCervicalMucusFieldExpr MCContraceptiveFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle contraceptive: type: string enum: - date - type title: Contraceptive description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - contraceptive title: MCContraceptiveFieldExpr MCDetectedDeviationsFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle detected_deviations: type: string enum: - date - deviation title: Detected Deviations description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - detected_deviations title: MCDetectedDeviationsFieldExpr MCHomePregnancyTestFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle home_pregnancy_test: type: string enum: - date - test_result title: Home Pregnancy Test description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - home_pregnancy_test title: MCHomePregnancyTestFieldExpr MCHomeProgesteroneTestFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle home_progesterone_test: type: string enum: - date - test_result title: Home Progesterone Test description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - home_progesterone_test title: MCHomeProgesteroneTestFieldExpr MCIntermenstrualBleedingFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle intermenstrual_bleeding: type: string const: date title: Intermenstrual Bleeding additionalProperties: false type: object required: - intermenstrual_bleeding title: MCIntermenstrualBleedingFieldExpr MCMenstrualFlowFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle menstrual_flow: type: string enum: - date - flow title: Menstrual Flow description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - menstrual_flow title: MCMenstrualFlowFieldExpr MCOvulationTestFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle ovulation_test: type: string enum: - date - test_result title: Ovulation Test description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - ovulation_test title: MCOvulationTestFieldExpr MCSexualActivityFieldExpr: properties: field_for: type: string const: menstrual_cycle title: Field For default: menstrual_cycle sexual_activity: type: string enum: - date - protection_used title: Sexual Activity description: ℹ️ This enum is non-exhaustive. additionalProperties: false type: object required: - sexual_activity title: MCSexualActivityFieldExpr Macros: properties: carbs: anyOf: - type: number - type: 'null' title: Carbs description: Amount of carbohydrates in grams (g) protein: anyOf: - type: number - type: 'null' title: Protein description: Amount of protein in grams (g) fats: $ref: '#/components/schemas/Fats' description: Details of fat content alcohol: anyOf: - type: number - type: 'null' title: Alcohol description: Amount of alcohol in grams (g) water: anyOf: - type: number - type: 'null' title: Water description: Amount of water in grams (g) fibre: anyOf: - type: number - type: 'null' title: Fibre description: Amount of dietary fiber in grams (g) sugar: anyOf: - type: number - type: 'null' title: Sugar description: Amount of sugar in grams (g) cholesterol: anyOf: - type: number - type: 'null' title: Cholesterol description: Amount of cholesterol in grams (g) type: object title: Macros MarkerType: type: string enum: - biomarker - panel title: MarkerType description: ℹ️ This enum is non-exhaustive. MealColumnExpr: properties: meal: type: string enum: - calories - carbohydrate_gram - protein_gram - alcohol_gram - water_gram - fibre_gram - sugar_gram - cholesterol_gram - saturated_fat_gram - monounsaturated_fat_gram - polyunsaturated_fat_gram - omega3_fat_gram - omega6_fat_gram - total_fat_gram - sodium_milligram - potassium_milligram - calcium_milligram - phosphorus_milligram - magnesium_milligram - iron_milligram - zinc_milligram - fluoride_milligram - chloride_milligram - vitamin_a_milligram - vitamin_b1_milligram - riboflavin_milligram - niacin_milligram - pantothenic_acid_milligram - vitamin_b6_milligram - biotin_microgram - vitamin_b12_microgram - vitamin_c_milligram - vitamin_d_microgram - vitamin_e_milligram - vitamin_k_microgram - folic_acid_microgram - chromium_microgram - copper_milligram - iodine_microgram - manganese_milligram - molybdenum_microgram - selenium_microgram - date - name - source_type - source_provider - source_app_id - source_device_id title: Meal description: ℹ️ This enum is non-exhaustive. type: object required: - meal title: MealColumnExpr MealInDBBase_ClientFacingSource_: properties: id: type: string format: uuid title: Id user_id: type: string format: uuid title: User Id priority_id: type: integer title: Priority Id description: This value has no meaning. deprecated: true source_id: type: integer title: Source Id description: This value has no meaning. deprecated: true provider_id: type: string title: Provider Id description: This value is identical to `id`. deprecated: true timestamp: type: string format: date-time title: Timestamp calendar_date: type: string format: date title: Calendar Date description: Date of the meal in the YYYY-mm-dd format. For providers that only expose a date, this is the calendar date as recorded by the user. name: type: string title: Name energy: anyOf: - $ref: '#/components/schemas/Energy' - type: 'null' macros: anyOf: - $ref: '#/components/schemas/Macros' - type: 'null' micros: anyOf: - $ref: '#/components/schemas/Micros' - type: 'null' data: additionalProperties: $ref: '#/components/schemas/ClientFacingFood' type: object title: Data default: {} source: $ref: '#/components/schemas/ClientFacingSource' created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At source_app_id: anyOf: - type: string - type: 'null' title: Source App Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id type: object required: - id - user_id - priority_id - source_id - provider_id - timestamp - calendar_date - name - energy - macros - micros - source - created_at - updated_at title: MealInDBBase[ClientFacingSource] example: calendar_date: '2019-08-24' created_at: '2023-02-27T20:31:24+00:00' data: Chiken coquet starter: energy: unit: kcal value: 400 macros: carbs: 75 fats: monounsaturated: 1 omega3: 0 omega6: 0 polyunsaturated: 1 saturated: 98 total: 100 protein: 10 sugar: 25 micros: minerals: sodium: 500 Coffee, black, 1 tbsp(s): energy: unit: kcal value: 0 macros: carbs: 0 fats: total: 0 protein: 0 sugar: 0 micros: minerals: sodium: 0 id: 497f6eca-6276-4993-bfeb-53cbbbba6f08 name: Dinner priority_id: 42 provider_id: '123456' source: app_id: com.myfitnesspal.mfp device_id: 550e8400-e29b-41d4-a716-446655440000 provider: apple_health_kit type: unknown source_app_id: com.myfitnesspal.mfp source_id: 10 timestamp: '2019-08-24T00:00:00Z' updated_at: '2023-02-28T01:22:38+00:00' user_id: a169451c-8525-4352-b8ca-070dd449a1a5 MenstrualCycleColumnExpr: properties: menstrual_cycle: type: string enum: - period_start - period_end - cycle_end - is_predicted - menstrual_flow - cervical_mucus - intermenstrual_bleeding - contraceptive - detected_deviations - ovulation_test - home_pregnancy_test - home_progesterone_test - sexual_activity - basal_body_temperature - source_type - source_provider - source_app_id - source_device_id title: Menstrual Cycle description: ℹ️ This enum is non-exhaustive. type: object required: - menstrual_cycle title: MenstrualCycleColumnExpr MenstrualCycleResponse: properties: menstrual_cycle: items: $ref: '#/components/schemas/ClientFacingMenstrualCycle' type: array title: Menstrual Cycle type: object required: - menstrual_cycle title: MenstrualCycleResponse MenstrualFlowEntry: properties: date: type: string format: date title: Date flow: type: string enum: - unspecified - none - light - medium - heavy title: Flow description: ℹ️ This enum is non-exhaustive. type: object required: - date - flow title: MenstrualFlowEntry MetricsResult: properties: team_id: anyOf: - type: string - type: string format: uuid title: Team Id number_of_connected_sources: type: integer title: Number Of Connected Sources default: 0 number_of_users: type: integer title: Number Of Users default: 0 number_of_errored_connected_sources: type: integer title: Number Of Errored Connected Sources default: 0 number_of_connected_sources_by_week: items: $ref: '#/components/schemas/TimeseriesMetricPoint' type: array title: Number Of Connected Sources By Week default: [] number_of_ordered_tests: type: integer title: Number Of Ordered Tests default: 0 type: object required: - team_id title: MetricsResult Micros: properties: minerals: anyOf: - additionalProperties: type: number propertyNames: $ref: '#/components/schemas/Minerals' type: object - type: 'null' title: Minerals description: Amount of each mineral in their respective units. Most minerals are measured in mg (milligrams), while sodium and potassium are in g (grams). trace_elements: anyOf: - additionalProperties: type: number propertyNames: $ref: '#/components/schemas/TraceElements' type: object - type: 'null' title: Trace Elements description: Amount of each trace element in their respective units, most measured in μg (micrograms), while copper and manganese are in mg (milligrams). vitamins: anyOf: - additionalProperties: type: number propertyNames: $ref: '#/components/schemas/Vitamins' type: object - type: 'null' title: Vitamins description: Amount of each vitamin in their respective units. A, B12, D and K in μg (micrograms), while B1, B2, B3, B5, B6, C and folic acid are in mg (milligrams). type: object title: Micros Minerals: type: string enum: - sodium - potassium - calcium - phosphorus - magnesium - iron - zinc - fluoride - chloride title: Minerals description: ℹ️ This enum is non-exhaustive. MissingBiomarkerResult: properties: name: type: string title: Name slug: type: string title: Slug inferred_failure_type: $ref: '#/components/schemas/FailureType' description: ℹ️ This enum is non-exhaustive. note: anyOf: - type: string - type: 'null' title: Note loinc: anyOf: - type: string - type: 'null' title: Loinc loinc_slug: anyOf: - type: string - type: 'null' title: Loinc Slug provider_id: anyOf: - type: string - type: 'null' title: Provider Id source_markers: anyOf: - items: $ref: '#/components/schemas/ParentBiomarkerData' type: array - type: 'null' title: Source Markers type: object required: - name - slug - inferred_failure_type title: MissingBiomarkerResult NoteTimeseriesExpr: properties: timeseries: type: string const: note title: Timeseries field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - tags - content title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: NoteTimeseriesExpr OAuthProviders: type: string enum: - oura - fitbit - garmin - strava - wahoo - ihealth - withings - google_fit - dexcom_v3 - polar - cronometer - omron - whoop_v2 - my_fitness_pal_v2 - ultrahuman - runkeeper title: OAuthProviders description: ℹ️ This enum is non-exhaustive. OrderActivationType: type: string enum: - current - scheduled title: OrderActivationType description: ℹ️ This enum is non-exhaustive. OrderLowLevelStatus: type: string enum: - ordered - requisition_created - requisition_bypassed - transit_customer - out_for_delivery - with_customer - transit_lab - delivered_to_lab - completed - failure_to_deliver_to_lab - failure_to_deliver_to_customer - problem_in_transit_lab - problem_in_transit_customer - sample_error - appointment_scheduled - appointment_cancelled - appointment_pending - draw_completed - cancelled - lost - do_not_process - partial_results - awaiting_registration - registered - redraw_available - corrected - lab_processing_blocked title: OrderLowLevelStatus description: ℹ️ This enum is non-exhaustive. OrderOrigin: type: string enum: - initial - redraw - recreation title: OrderOrigin description: ℹ️ This enum is non-exhaustive. OrderSetRequest: properties: lab_test_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Lab Test Ids add_on: anyOf: - $ref: '#/components/schemas/AddOnOrder' - type: 'null' lab_account_id: anyOf: - type: string format: uuid - type: 'null' title: Lab Account Id type: object title: OrderSetRequest OrderStatus: type: string enum: - received.walk_in_test.ordered - received.walk_in_test.requisition_created - received.walk_in_test.requisition_bypassed - completed.walk_in_test.completed - sample_with_lab.walk_in_test.partial_results - failed.walk_in_test.sample_error - cancelled.walk_in_test.cancelled - collecting_sample.walk_in_test.appointment_pending - collecting_sample.walk_in_test.appointment_scheduled - collecting_sample.walk_in_test.appointment_cancelled - collecting_sample.walk_in_test.redraw_available - received.at_home_phlebotomy.ordered - received.at_home_phlebotomy.requisition_created - received.at_home_phlebotomy.requisition_bypassed - collecting_sample.at_home_phlebotomy.appointment_pending - collecting_sample.at_home_phlebotomy.appointment_scheduled - collecting_sample.at_home_phlebotomy.draw_completed - collecting_sample.at_home_phlebotomy.appointment_cancelled - completed.at_home_phlebotomy.completed - sample_with_lab.at_home_phlebotomy.partial_results - cancelled.at_home_phlebotomy.cancelled - failed.at_home_phlebotomy.sample_error - received.testkit.ordered - received.testkit.awaiting_registration - received.testkit.requisition_created - received.testkit.requisition_bypassed - received.testkit.registered - collecting_sample.testkit.transit_customer - collecting_sample.testkit.out_for_delivery - collecting_sample.testkit.with_customer - collecting_sample.testkit.transit_lab - sample_with_lab.testkit.delivered_to_lab - sample_with_lab.testkit.lab_processing_blocked - completed.testkit.completed - failed.testkit.failure_to_deliver_to_customer - failed.testkit.failure_to_deliver_to_lab - failed.testkit.sample_error - failed.testkit.lost - cancelled.testkit.cancelled - cancelled.testkit.do_not_process - collecting_sample.testkit.problem_in_transit_customer - collecting_sample.testkit.problem_in_transit_lab - received.on_site_collection.ordered - received.on_site_collection.requisition_created - received.on_site_collection.requisition_bypassed - sample_with_lab.on_site_collection.draw_completed - completed.on_site_collection.completed - cancelled.on_site_collection.cancelled - sample_with_lab.on_site_collection.partial_results - failed.on_site_collection.sample_error - completed.walk_in_test.corrected - completed.at_home_phlebotomy.corrected - completed.on_site_collection.corrected - completed.testkit.corrected title: OrderStatus description: 'Used in combination with OrderStatusDetail to represent the current order state. OrderStatus is driven by a FSM whereas OrderStatusDetail is descriptive only. ℹ️ This enum is non-exhaustive.' OrderStatusDetail: type: string enum: - fulfillment_error - date_of_collection_unspecified - demographic_information_unspecified - demographic_information_mismatch - sample_quantity_not_sufficient - sample_contaminated - sample_stability_exceeded - sample_hemolyzed - sample_improper_collection title: OrderStatusDetail description: A descriptive-only additional field to be used in combination with OrderStatus. Exposed in the API. ℹ️ This enum is non-exhaustive. OrderSummary: properties: id: type: string format: uuid title: Id origin: anyOf: - $ref: '#/components/schemas/OrderOrigin' - type: 'null' description: ℹ️ This enum is non-exhaustive. parent_id: anyOf: - type: string format: uuid - type: 'null' title: Parent Id last_status: $ref: '#/components/schemas/OrderLowLevelStatus' description: ℹ️ This enum is non-exhaustive. last_status_created_at: type: string format: date-time title: Last Status Created At updated_at: type: string format: date-time title: Updated At created_at: type: string format: date-time title: Created At type: object required: - id - last_status - last_status_created_at - updated_at - created_at title: OrderSummary description: Lightweight order summary. OrderTopLevelStatus: type: string enum: - received - collecting_sample - sample_with_lab - completed - cancelled - failed title: OrderTopLevelStatus description: ℹ️ This enum is non-exhaustive. OrderTransactionStatus: type: string enum: - active - completed - cancelled title: OrderTransactionStatus description: ℹ️ This enum is non-exhaustive. OvulationTestEntry: properties: date: type: string format: date title: Date test_result: type: string enum: - negative - positive - luteinizing_hormone_surge - estrogen_surge - indeterminate title: Test Result description: ℹ️ This enum is non-exhaustive. type: object required: - date - test_result title: OvulationTestEntry PSCAreaInfo: properties: patient_service_centers: $ref: '#/components/schemas/PSCAreaInfoDetails' supported_bill_types: items: $ref: '#/components/schemas/Billing' type: array title: Supported Bill Types lab_id: type: integer title: Lab Id type: object required: - patient_service_centers - supported_bill_types - lab_id title: PSCAreaInfo PSCAreaInfoDetails: properties: appointment_with_vital: type: boolean title: Appointment With Vital within_radius: type: integer title: Within Radius radius: type: string title: Radius capabilities: items: $ref: '#/components/schemas/LabLocationCapability' type: array title: Capabilities type: object required: - appointment_with_vital - within_radius - radius title: PSCAreaInfoDetails PSCInfo: properties: lab_id: type: integer title: Lab Id slug: $ref: '#/components/schemas/Labs' description: ℹ️ This enum is non-exhaustive. patient_service_centers: items: $ref: '#/components/schemas/ClientFacingLabLocation' type: array title: Patient Service Centers type: object required: - lab_id - slug - patient_service_centers title: PSCInfo PaginatedUsersResponse: properties: users: items: $ref: '#/components/schemas/ClientFacingUser' type: array title: Users total: type: integer title: Total offset: type: integer title: Offset limit: type: integer title: Limit type: object required: - users - total - offset - limit title: PaginatedUsersResponse ParentBiomarkerData: properties: marker_id: type: integer title: Marker Id name: type: string title: Name slug: type: string title: Slug provider_id: anyOf: - type: string - type: 'null' title: Provider Id type: object required: - marker_id - name - slug title: ParentBiomarkerData ParsedLabReportData: properties: metadata: $ref: '#/components/schemas/ResultMetadata' results: items: $ref: '#/components/schemas/LabReportResult' type: array title: Results type: object required: - metadata - results title: ParsedLabReportData ParsingJob: properties: id: type: string format: uuid title: Id status: $ref: '#/components/schemas/ParsingJobStatus' description: ℹ️ This enum is non-exhaustive. failure_reason: anyOf: - $ref: '#/components/schemas/ParsingJobFailureReason' - type: 'null' description: ℹ️ This enum is non-exhaustive. data: anyOf: - $ref: '#/components/schemas/ParsedLabReportData' - type: 'null' needs_human_review: type: boolean title: Needs Human Review is_reviewed: type: boolean title: Is Reviewed type: object required: - id - status - needs_human_review - is_reviewed title: ParsingJob example: data: metadata: date_collected: '2024-12-30' date_reported: '2025-01-01' dob: '1990-01-01' lab_name: Acme Labs patient_first_name: Jane patient_last_name: Doe specimen_number: ABC123 results: - interpretation: normal is_above_max_range: false is_below_min_range: false loinc_matches: - aliases: [] confidence_score: 0.99 display_name: Glucose loinc_code: 2345-7 loinc_name: Glucose [Mass/volume] in Serum or Plasma max_reference_range: 99 measurement_kind: direct min_reference_range: 70 sample_type: serum_plasma_blood source_panel_name: CMP test_name: Glucose type: numeric units: mg/dL value: '90' id: 8eb0217f-4683-4a3c-adca-faf95ac65739 is_reviewed: false needs_human_review: false status: completed ParsingJobFailureReason: type: string enum: - invalid_input - low_quality - not_english title: ParsingJobFailureReason description: Machine-readable failure reasons for parsing jobs. ℹ️ This enum is non-exhaustive. ParsingJobStatus: type: string enum: - upload_pending - started - completed - failed title: ParsingJobStatus description: ℹ️ This enum is non-exhaustive. PasswordProviders: type: string enum: - whoop - renpho - peloton - zwift - eight_sleep - beurer_api - dexcom - hammerhead - my_fitness_pal - kardia - abbott_libreview - tandem_source title: PasswordProviders description: ℹ️ This enum is non-exhaustive. PatientAddress: properties: receiver_name: type: string title: Receiver Name first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip: type: string title: Zip country: type: string title: Country access_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Access Notes type: object required: - receiver_name - first_line - city - state - zip - country title: PatientAddress PatientAddressCompatible: properties: receiver_name: type: string title: Receiver Name default: '' first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip: type: string title: Zip country: type: string title: Country access_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Access Notes phone_number: anyOf: - type: string - type: 'null' title: Phone Number type: object required: - first_line - city - state - zip - country title: PatientAddressCompatible PatientAddressWithValidation: properties: receiver_name: type: string title: Receiver Name default: '' first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip: type: string pattern: ^\d{5}(-\d{4})?$ title: Zip country: type: string title: Country access_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Access Notes phone_number: anyOf: - type: string - type: 'null' title: Phone Number type: object required: - first_line - city - state - zip - country title: PatientAddressWithValidation PatientDetailsWithValidation: properties: first_name: type: string maxLength: 50 minLength: 1 title: First Name last_name: type: string maxLength: 50 minLength: 1 title: Last Name dob: type: string format: date title: Dob gender: $ref: '#/components/schemas/Gender' description: ℹ️ This enum is non-exhaustive. phone_number: type: string title: Phone Number email: type: string format: email title: Email medical_proxy: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' description: Parent/medical_proxy details. Required if patient is a minor. race: anyOf: - $ref: '#/components/schemas/Race' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. ethnicity: anyOf: - $ref: '#/components/schemas/Ethnicity' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. sexual_orientation: anyOf: - $ref: '#/components/schemas/SexualOrientation' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. gender_identity: anyOf: - $ref: '#/components/schemas/GenderIdentity' - type: 'null' description: If not provided, will be set to 'Not Specified' ℹ️ This enum is non-exhaustive. household_income: anyOf: - type: integer - type: 'null' title: Household Income description: Household income in USD. If not provided, will be set to None household_size: anyOf: - type: integer - type: 'null' title: Household Size description: Household size. If not provided, will be set to None type: object required: - first_name - last_name - dob - gender - phone_number - email title: PatientDetailsWithValidation description: Patient details with validation for first_name, last_name, email, and dob. PayorCodeExternalProvider: type: string enum: - change_healthcare - availity - stedi - waystar - claim_md - apero - pverify title: PayorCodeExternalProvider description: ℹ️ This enum is non-exhaustive. PayorSearchRequest: properties: insurance_name: anyOf: - type: string - type: 'null' title: Insurance Name provider: anyOf: - $ref: '#/components/schemas/PayorCodeExternalProvider' - type: 'null' description: ℹ️ This enum is non-exhaustive. provider_id: anyOf: - type: string - type: 'null' title: Provider Id type: object title: PayorSearchRequest PerLabCandidate: properties: marker_id: type: integer title: Marker Id lab_id: type: integer title: Lab Id lab_slug: anyOf: - type: string - type: 'null' title: Lab Slug name: type: string title: Name result_names: items: type: string type: array title: Result Names provider_id: anyOf: - type: string - type: 'null' title: Provider Id loinc_set_hash: type: string title: Loinc Set Hash loinc_codes: items: type: string type: array title: Loinc Codes loinc_components: items: type: string type: array title: Loinc Components loinc_groups: items: type: string type: array title: Loinc Groups cpt_codes: items: type: string type: array title: Cpt Codes relation: type: string title: Relation confidence: type: number title: Confidence reason_codes: items: type: string type: array title: Reason Codes marker_popularity_score: type: number title: Marker Popularity Score type: object required: - marker_id - lab_id - name - loinc_set_hash - relation - confidence - marker_popularity_score title: PerLabCandidate PerformingLaboratory: properties: name: type: string title: Name phone_number: anyOf: - type: string - type: 'null' title: Phone Number medical_director: anyOf: - type: string - type: 'null' title: Medical Director address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' type: object required: - name title: PerformingLaboratory Period: properties: value: type: integer minimum: 1 title: Value default: 1 unit: type: string enum: - minute - hour - day - week - month - year title: Unit description: ℹ️ This enum is non-exhaustive. type: object required: - unit title: Period PhlebotomyAreaInfo: properties: is_served: type: boolean title: Is Served providers: items: $ref: '#/components/schemas/PhlebotomyProviderInfo' type: array title: Providers type: object required: - is_served - providers title: PhlebotomyAreaInfo PhlebotomyProviderInfo: properties: name: $ref: '#/components/schemas/AppointmentProvider' description: ℹ️ This enum is non-exhaustive. service_types: items: $ref: '#/components/schemas/AppointmentServiceType' type: array title: Service Types type: object required: - name - service_types title: PhlebotomyProviderInfo PhysicianCreateRequest: properties: first_name: type: string title: First Name last_name: type: string title: Last Name email: anyOf: - type: string - type: 'null' title: Email npi: type: string title: Npi licensed_states: items: type: string type: array title: Licensed States signature_image: anyOf: - $ref: '#/components/schemas/Jpeg' - $ref: '#/components/schemas/Png' - type: 'null' title: Signature Image description: An image of the physician signature for health insurance billing type: object required: - first_name - last_name - npi title: PhysicianCreateRequest PhysicianCreateRequestBase: properties: first_name: type: string title: First Name last_name: type: string title: Last Name email: anyOf: - type: string - type: 'null' title: Email npi: type: string title: Npi licensed_states: items: type: string type: array title: Licensed States type: object required: - first_name - last_name - npi title: PhysicianCreateRequestBase Placeholder: properties: placeholder: type: boolean const: true title: Placeholder type: object required: - placeholder title: Placeholder Png: properties: content: type: string title: Content format: binary content_type: type: string const: image/png title: Content Type type: object required: - content - content_type title: Png PostOrderResponse: properties: order: $ref: '#/components/schemas/ClientFacingOrder' status: type: string title: Status message: type: string title: Message type: object required: - order - status - message title: PostOrderResponse PriorityResource: type: string enum: - workouts - activity - sleep - body - timeseries title: PriorityResource description: ℹ️ This enum is non-exhaustive. ProfileColumnExpr: properties: profile: type: string enum: - height_centimeter - birth_date - wheelchair_use - gender - sex - source_type - source_provider - source_app_id - source_device_id - created_at - updated_at title: Profile description: ℹ️ This enum is non-exhaustive. type: object required: - profile title: ProfileColumnExpr ProfileInDb: properties: id: type: string format: uuid title: Id data: title: Data user_id: type: string format: uuid title: User Id source_id: type: integer title: Source Id deprecated: true priority_id: anyOf: - type: integer - type: 'null' title: Priority Id deprecated: true source: $ref: '#/components/schemas/ClientFacingProvider' created_at: type: string format: date-time title: Created At default: '0001-01-01T00:00:00Z' updated_at: type: string format: date-time title: Updated At default: '0001-01-01T00:00:00Z' type: object required: - id - data - user_id - source_id - source title: ProfileInDb ProviderConnectionCreated: properties: user_id: type: string format: uuid title: User Id source: $ref: '#/components/schemas/ClientFacingProvider' description: Deprecated. Use `provider` instead. Subject to removal after 1 Jan 2024. deprecated: true provider: $ref: '#/components/schemas/ClientFacingProvider' external_user_id: anyOf: - type: string - type: 'null' title: External User Id description: ' The unique identifier of the associated external data provider user. * OAuth Providers: User unique identifier; provider-specific formats * Password Providers: Username * Email Providers: Email * Junction Mobile SDK Providers: `null` (not available) ' resource_availability: additionalProperties: $ref: '#/components/schemas/ResourceAvailability' propertyNames: $ref: '#/components/schemas/Resource' type: object title: Resource Availability type: object required: - user_id - source - provider - external_user_id - resource_availability title: ProviderConnectionCreated example: provider: logo: https://logo_url.com name: Fitbit slug: fitbit resource_availability: body: scope_requirements: user_denied: optional: [] required: [] user_granted: optional: [] required: - weight status: available sleep: scope_requirements: user_denied: optional: - heartrate - oxygen_saturation - respiratory_rate required: - sleep user_granted: optional: [] required: [] status: unavailable user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ProviderConnectionError: properties: provider: type: string title: Provider user_id: type: string format: uuid title: User Id message: type: string title: Message error_type: type: string enum: - token_refresh_failed - webhook_registration_failed - user_not_found - deregistered_per_provider - required_scopes_not_granted - provider_credential_error - provider_password_expired - unknown title: Error Type description: ℹ️ This enum is non-exhaustive. error_details: type: string title: Error Details type: object required: - provider - user_id - message - error_type - error_details title: ProviderConnectionError example: error_details: Failed to pull provider data error_type: token_refresh_failed message: We are having issues fetching information for user. We won't try to fetch again from this specific provider. Please reconnect device. provider: oura user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 ProviderIdConversionResponse: properties: source_provider_id: type: string title: Source Provider Id candidates: items: $ref: '#/components/schemas/PerLabCandidate' type: array title: Candidates type: object required: - source_provider_id title: ProviderIdConversionResponse ProviderLinkResponse: properties: state: type: string enum: - success - error - pending_provider_mfa title: State description: ℹ️ This enum is non-exhaustive. redirect_url: anyOf: - type: string - type: 'null' title: Redirect Url description: The redirect URL you supplied when creating the Link Token (via `POST /v2/link/token`). error_type: anyOf: - type: string enum: - invalid_token - token_expired - token_not_validated - token_consumed - provider_credential_error - provider_password_expired - provider_api_error - unsupported_region - duplicate_connection - required_scopes_not_granted - incorrect_mfa_code - user_cancelled - type: 'null' title: Error Type description: The Link Error Type. This field is populated only when state is `error`. ℹ️ This enum is non-exhaustive. error: anyOf: - type: string - type: 'null' title: Error description: A developer-readable debug description of the Link Error. This field is populated only when state is `error`. provider_mfa: anyOf: - $ref: '#/components/schemas/ProviderMFARequest' - type: 'null' description: The provider MFA request. This field is populated only when state is `pending_provider_mfa`. provider: $ref: '#/components/schemas/PasswordProviders' deprecated: true description: ℹ️ This enum is non-exhaustive. connected: type: boolean title: Connected deprecated: true provider_id: anyOf: - type: string - type: 'null' title: Provider Id deprecated: true type: object required: - state - provider - connected - provider_id title: ProviderLinkResponse example: state: success ProviderMFARequest: properties: method: type: string enum: - sms - email title: Method description: The MFA method requested by the password provider to complete authentication. ℹ️ This enum is non-exhaustive. hint: type: string title: Hint description: The MFA hint provided by the password provider, e.g., the redacted phone number. type: object required: - method - hint title: ProviderMFARequest Providers: type: string enum: - oura - fitbit - garmin - whoop - strava - renpho - peloton - wahoo - zwift - freestyle_libre - abbott_libreview - tandem_source - freestyle_libre_ble - eight_sleep - withings - apple_health_kit - manual - ihealth - google_fit - beurer_api - beurer_ble - omron - omron_ble - onetouch_ble - accuchek_ble - contour_ble - dexcom - dexcom_v3 - hammerhead - my_fitness_pal - health_connect - samsung_health - polar - cronometer - kardia - whoop_v2 - ultrahuman - my_fitness_pal_v2 - map_my_fitness - runkeeper title: Providers description: ℹ️ This enum is non-exhaustive. Query: properties: select: items: anyOf: - $ref: '#/components/schemas/AggregateExpr' - $ref: '#/components/schemas/GroupKeyColumnExpr' - $ref: '#/components/schemas/SleepColumnExpr' - $ref: '#/components/schemas/DerivedReadinessColumnExpr' - $ref: '#/components/schemas/ActivityColumnExpr' - $ref: '#/components/schemas/WorkoutColumnExpr' - $ref: '#/components/schemas/BodyColumnExpr' - $ref: '#/components/schemas/MealColumnExpr' - $ref: '#/components/schemas/MenstrualCycleColumnExpr' - $ref: '#/components/schemas/ProfileColumnExpr' - $ref: '#/components/schemas/SleepScoreValueMacroExpr' - $ref: '#/components/schemas/ChronotypeValueMacroExpr' - $ref: '#/components/schemas/AsleepAtValueMacroExpr' - $ref: '#/components/schemas/AwakeAtValueMacroExpr' - $ref: '#/components/schemas/AwakeningsValueMacroExpr' - $ref: '#/components/schemas/UnrecognizedValueMacroExpr' - $ref: '#/components/schemas/DiscreteTimeseriesExpr' - $ref: '#/components/schemas/IntervalTimeseriesExpr' - $ref: '#/components/schemas/InsulinInjectionTimeseriesExpr' - $ref: '#/components/schemas/BloodPressureTimeseriesExpr' - $ref: '#/components/schemas/TemperatureTimeseriesExpr' - $ref: '#/components/schemas/WorkoutDurationTimeseriesExpr' - $ref: '#/components/schemas/NoteTimeseriesExpr' - $ref: '#/components/schemas/IndexColumnExpr' - $ref: '#/components/schemas/ScalarOutputSubqueryExpr' - $ref: '#/components/schemas/SourceColumnExpr' type: array title: Select group_by: items: anyOf: - $ref: '#/components/schemas/DateTruncExpr' - $ref: '#/components/schemas/DatePartExpr' - $ref: '#/components/schemas/SleepColumnExpr' - $ref: '#/components/schemas/DerivedReadinessColumnExpr' - $ref: '#/components/schemas/ActivityColumnExpr' - $ref: '#/components/schemas/WorkoutColumnExpr' - $ref: '#/components/schemas/BodyColumnExpr' - $ref: '#/components/schemas/MealColumnExpr' - $ref: '#/components/schemas/MenstrualCycleColumnExpr' - $ref: '#/components/schemas/ProfileColumnExpr' - $ref: '#/components/schemas/SleepScoreValueMacroExpr' - $ref: '#/components/schemas/ChronotypeValueMacroExpr' - $ref: '#/components/schemas/AsleepAtValueMacroExpr' - $ref: '#/components/schemas/AwakeAtValueMacroExpr' - $ref: '#/components/schemas/AwakeningsValueMacroExpr' - $ref: '#/components/schemas/UnrecognizedValueMacroExpr' - $ref: '#/components/schemas/DiscreteTimeseriesExpr' - $ref: '#/components/schemas/IntervalTimeseriesExpr' - $ref: '#/components/schemas/InsulinInjectionTimeseriesExpr' - $ref: '#/components/schemas/BloodPressureTimeseriesExpr' - $ref: '#/components/schemas/TemperatureTimeseriesExpr' - $ref: '#/components/schemas/WorkoutDurationTimeseriesExpr' - $ref: '#/components/schemas/NoteTimeseriesExpr' - $ref: '#/components/schemas/SourceColumnExpr' type: array title: Group By where: anyOf: - type: string - type: 'null' title: Where description: 'A WHERE clause filtering the input data. If a GROUP BY clause is present, filtering happens prior to GROUP BY evaluation. WHERE clause uses SQL Expression syntax to describe the filtering criteria: * Available operators: `>`, `>=`, `<`, `<=`, `=`, `!=`, `NOT`, `AND` and `OR`. * Parentheses is supported.' type: object required: - select title: Query QueryBatch: properties: timeframe: anyOf: - $ref: '#/components/schemas/RelativeTimeframe' - $ref: '#/components/schemas/Placeholder' title: Timeframe queries: items: $ref: '#/components/schemas/Query' type: array title: Queries config: $ref: '#/components/schemas/QueryConfig' type: object required: - timeframe - queries title: QueryBatch QueryConfig: properties: provider_priority_overrides: anyOf: - items: anyOf: - $ref: '#/components/schemas/Providers' - $ref: '#/components/schemas/Labs' type: array - type: 'null' title: Provider Priority Overrides type: object title: QueryConfig Question: properties: id: type: integer format: int64 title: Id required: type: boolean title: Required code: type: string title: Code value: type: string title: Value type: $ref: '#/components/schemas/QuestionType' description: ℹ️ This enum is non-exhaustive. sequence: type: integer title: Sequence answers: items: $ref: '#/components/schemas/Answer' type: array title: Answers constraint: anyOf: - type: string - type: 'null' title: Constraint default: anyOf: - type: string - type: 'null' title: Default type: object required: - id - required - code - value - type - sequence - answers title: Question QuestionType: type: string enum: - choice - text - numeric - multi_choice title: QuestionType description: ℹ️ This enum is non-exhaustive. Race: type: string enum: - african_american_or_black - asian - indigenous_native_american_alaska_native - other - pacific_islander_or_hawaiian - white_caucasian title: Race description: ℹ️ This enum is non-exhaustive. RawActivity: properties: timestamp: type: string format: date-time title: Timestamp data: additionalProperties: true type: object title: Data user_id: type: string format: uuid4 title: User Id provider_id: type: string title: Provider Id deprecated: true source_id: type: integer title: Source Id deprecated: true priority_id: type: integer title: Priority Id deprecated: true id: type: string format: uuid title: Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At default: '0001-01-01T00:00:00Z' updated_at: type: string format: date-time title: Updated At default: '0001-01-01T00:00:00Z' source: $ref: '#/components/schemas/ClientFacingProvider' deprecated: true type: object required: - timestamp - data - user_id - provider_id - source_id - priority_id - id - source title: RawActivity RawActivityResponse: properties: activity: items: $ref: '#/components/schemas/RawActivity' type: array title: Activity type: object required: - activity title: Activity Data example: activity: - data: data: '...provider_specific_data' priority_id: 1 provider_id: 5e8271a3-e71b-4882-a94a-7e364694cd16 source_device_id: 550e8400-e29b-41d4-a716-446655440000 source_id: 1 timestamp: '2023-03-22T00:00:00+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 RawBody: properties: timestamp: type: string format: date-time title: Timestamp data: additionalProperties: true type: object title: Data user_id: type: string format: uuid title: User Id provider_id: type: string title: Provider Id deprecated: true source_id: type: integer title: Source Id deprecated: true priority_id: anyOf: - type: integer - type: 'null' title: Priority Id deprecated: true id: type: string format: uuid title: Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At default: '0001-01-01T00:00:00Z' updated_at: type: string format: date-time title: Updated At default: '0001-01-01T00:00:00Z' priority: anyOf: - type: integer - type: 'null' title: Priority deprecated: true source: $ref: '#/components/schemas/ClientFacingProvider' deprecated: true type: object required: - timestamp - data - user_id - provider_id - source_id - priority_id - id - source title: RawBody RawBodyResponse: properties: body: items: $ref: '#/components/schemas/RawBody' type: array title: Body type: object required: - body title: Body Data example: body: - data: data: '...provider_specific_data' priority_id: 1 provider_id: 5e8271a3-e71b-4882-a94a-7e364694cd16 source_device_id: 550e8400-e29b-41d4-a716-446655440000 source_id: 1 timestamp: '2023-02-27T12:31:24+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 RawDevice: properties: data: additionalProperties: true type: object title: Data provider_id: type: string title: Provider Id user_id: type: string format: uuid title: User Id source_id: type: integer title: Source Id id: type: string format: uuid title: Id source: $ref: '#/components/schemas/ClientFacingProvider' type: object required: - data - provider_id - user_id - source_id - id - source title: RawDevice RawDevicesResponse: properties: devices: items: $ref: '#/components/schemas/RawDevice' type: array title: Devices type: object required: - devices title: Raw Devices Data example: devices: - data: data: '...provider_specific_data' provider_id: 5e8271a3-e71b-4882-a94a-7e364694cd16 source_id: 1 user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 RawProfile: properties: profile: $ref: '#/components/schemas/ProfileInDb' type: object required: - profile title: Profile Data example: profile: - data: data: '...provider_specific_data' source_id: 1 user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 RawSleep: properties: timestamp: type: string format: date-time title: Timestamp data: additionalProperties: true type: object title: Data user_id: type: string format: uuid title: User Id provider_id: type: string title: Provider Id deprecated: true source_id: type: integer title: Source Id deprecated: true priority_id: anyOf: - type: integer - type: 'null' title: Priority Id deprecated: true id: type: string format: uuid title: Id source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At default: '0001-01-01T00:00:00Z' updated_at: type: string format: date-time title: Updated At default: '0001-01-01T00:00:00Z' source: $ref: '#/components/schemas/ClientFacingProvider' deprecated: true priority: anyOf: - type: integer - type: 'null' title: Priority deprecated: true type: object required: - timestamp - data - user_id - provider_id - source_id - priority_id - id - source title: RawSleep RawSleepResponse: properties: sleep: items: $ref: '#/components/schemas/RawSleep' type: array title: Sleep type: object required: - sleep title: Raw Sleep data example: sleep: - data: data: '...provider_specific_data' priority_id: 1 provider_id: 5e8271a3-e71b-4882-a94a-7e364694cd16 source_device_id: 550e8400-e29b-41d4-a716-446655440000 source_id: 1 timestamp: '2023-02-27T12:31:24+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 RawWorkout: properties: timestamp: type: string format: date-time title: Timestamp data: additionalProperties: true type: object title: Data user_id: type: string format: uuid4 title: User Id provider_id: type: string title: Provider Id deprecated: true source_id: type: integer title: Source Id deprecated: true priority_id: anyOf: - type: integer - type: 'null' title: Priority Id deprecated: true id: type: string format: uuid title: Id sport_id: type: integer title: Sport Id sport: $ref: '#/components/schemas/ClientFacingSport' source_device_id: anyOf: - type: string format: uuid - type: 'null' title: Source Device Id created_at: type: string format: date-time title: Created At default: '0001-01-01T00:00:00Z' updated_at: type: string format: date-time title: Updated At default: '0001-01-01T00:00:00Z' source: $ref: '#/components/schemas/ClientFacingProvider' deprecated: true type: object required: - timestamp - data - user_id - provider_id - source_id - priority_id - id - sport_id - sport - source title: RawWorkout RawWorkoutResponse: properties: workouts: items: $ref: '#/components/schemas/RawWorkout' type: array title: Workouts type: object required: - workouts title: Workouts Data example: workouts: - data: provider_specific: '..._data' priority_id: 1 provider_id: 5e8271a3-e71b-4882-a94a-7e364694cd16 source_device_id: 550e8400-e29b-41d4-a716-446655440000 source_id: 1 sport_id: 3 timestamp: '2023-02-27T12:31:24+00:00' user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 Region: type: string enum: - us - eu - de - fr - ca - br - ar - cl - co - mx - gb - ie - au - nz - nl - at - be - bh - ch - cz - dk - eg - es - fi - gr - hr - il - it - jo - kw - lb - lu - 'no' - om - pl - pt - qa - sa - se - si - sk - tr - za - in - sg - hk - kr - ph - tw title: Region description: ℹ️ This enum is non-exhaustive. RegisterTestkitRequest: properties: user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id description: The user ID of the patient. deprecated: true sample_id: type: string title: Sample Id patient_details: $ref: '#/components/schemas/PatientDetailsWithValidation' patient_address: $ref: '#/components/schemas/PatientAddressWithValidation' physician: anyOf: - $ref: '#/components/schemas/PhysicianCreateRequestBase' - type: 'null' health_insurance: anyOf: - $ref: '#/components/schemas/HealthInsuranceCreateRequest' - type: 'null' consents: items: $ref: '#/components/schemas/Consent' type: array title: Consents type: object required: - sample_id - patient_details - patient_address title: RegisterTestkitRequest RelatedCandidate: properties: canonical: $ref: '#/components/schemas/CanonicalCandidate' relation: type: string title: Relation confidence: type: number title: Confidence reason_codes: items: type: string type: array title: Reason Codes type: object required: - canonical - relation - confidence title: RelatedCandidate RelativeTimeframe: properties: type: type: string const: relative title: Type anchor: type: string format: date title: Anchor past: $ref: '#/components/schemas/Period' type: object required: - type - anchor - past title: RelativeTimeframe RequestAppointmentRequest: properties: address: $ref: '#/components/schemas/USAddress' description: At-home phlebotomy appointment address. provider: $ref: '#/components/schemas/AppointmentProvider' description: ℹ️ This enum is non-exhaustive. appointment_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Appointment Notes type: object required: - address - provider title: RequestAppointmentRequest ResendWebhookBody: properties: order_ids: anyOf: - items: type: string format: uuid type: array - type: 'null' title: Order Ids start_at: anyOf: - type: string format: date-time - type: 'null' title: Start At end_at: anyOf: - type: string format: date-time - type: 'null' title: End At type: object title: ResendWebhookBody ResendWebhookResponse: properties: order_ids: items: type: string format: uuid type: array title: Order Ids type: object required: - order_ids title: ResendWebhookResponse Resource: type: string enum: - profile - activity - sleep - body - workouts - workout_stream - connection - order - result - match_review - appointment - glucose - heartrate - hrv - hrv - ige - igg - blood_oxygen - blood_pressure - cholesterol - device - device_legacy - weight - fat - body_temperature - body_temperature_delta - meal - water - caffeine - mindfulness_minutes - steps - calories_active - distance - floors_climbed - respiratory_rate - vo2_max - calories_basal - stress_level - menstrual_cycle - sleep_cycle - electrocardiogram - electrocardiogram_voltage - afib_burden - heart_rate_alert - stand_hour - stand_duration - sleep_apnea_alert - sleep_breathing_disturbance - wheelchair_push - forced_expiratory_volume_1 - forced_vital_capacity - peak_expiratory_flow_rate - inhaler_usage - fall - uv_exposure - daylight_exposure - handwashing - basal_body_temperature - heart_rate_recovery_one_minute - body_mass_index - lean_body_mass - waist_circumference - workout_distance - workout_swimming_stroke - workout_duration - insulin_injection - carbohydrates - note - sleep_stream - hypnogram title: ClientFacingResource x-fern-type-name: ClientFacingResource description: ℹ️ This enum is non-exhaustive. ResourceAvailability: properties: status: $ref: '#/components/schemas/Availability' description: ℹ️ This enum is non-exhaustive. scope_requirements: anyOf: - $ref: '#/components/schemas/ScopeRequirementsGrants' - type: 'null' type: object required: - status title: ResourceAvailability ResponsibleRelationship: type: string enum: - Self - Spouse - Other title: ResponsibleRelationship description: ℹ️ This enum is non-exhaustive. ResultMetadata: properties: patient_first_name: anyOf: - type: string - type: 'null' title: Patient First Name patient_last_name: anyOf: - type: string - type: 'null' title: Patient Last Name dob: anyOf: - type: string - type: 'null' title: Dob gender: type: string enum: - male - female - other title: Gender default: other description: ℹ️ This enum is non-exhaustive. lab_name: anyOf: - type: string - type: 'null' title: Lab Name date_reported: anyOf: - type: string - type: 'null' title: Date Reported date_collected: anyOf: - type: string - type: 'null' title: Date Collected specimen_number: anyOf: - type: string - type: 'null' title: Specimen Number type: object title: ResultMetadata ResultType: type: string enum: - numeric - range - comment - coded_value title: ResultType description: ℹ️ This enum is non-exhaustive. SampleData: properties: sample_id: anyOf: - type: string - type: 'null' title: Sample Id control_number: anyOf: - type: string - type: 'null' title: Control Number date_collected: anyOf: - $ref: '#/components/schemas/UTCTimestampWithTimezoneOffset' - type: string - type: 'null' title: Date Collected date_received: anyOf: - $ref: '#/components/schemas/UTCTimestampWithTimezoneOffset' - type: string - type: 'null' title: Date Received date_reported: anyOf: - $ref: '#/components/schemas/UTCTimestampWithTimezoneOffset' - type: string - type: 'null' title: Date Reported performing_laboratories: anyOf: - additionalProperties: $ref: '#/components/schemas/PerformingLaboratory' type: object - type: 'null' title: Performing Laboratories clinical_information: anyOf: - $ref: '#/components/schemas/ClinicalInformation' - type: 'null' type: object title: SampleData ScalarOutputSubqueryExpr: properties: select: anyOf: - $ref: '#/components/schemas/AggregateFieldExpr' - $ref: '#/components/schemas/Placeholder' title: Select from: anyOf: - $ref: '#/components/schemas/UnnestExpr' - $ref: '#/components/schemas/Placeholder' title: From where: anyOf: - type: string - type: 'null' title: Where type: object required: - select - from title: ScalarOutputSubqueryExpr description: A subquery that produces a single scalar value per row. ScopeRequirementsGrants: properties: user_granted: $ref: '#/components/schemas/ScopeRequirements_str_' user_denied: $ref: '#/components/schemas/ScopeRequirements_str_' type: object required: - user_granted - user_denied title: ScopeRequirementsGrants ScopeRequirements_str_: properties: required: items: type: string type: array title: Required optional: items: type: string type: array title: Optional type: object required: - required - optional title: ScopeRequirements[str] SearchCompendiumBody: properties: mode: $ref: '#/components/schemas/SearchMode' description: ℹ️ This enum is non-exhaustive. query: anyOf: - type: string - type: 'null' title: Query cpt_codes: items: type: string type: array title: Cpt Codes loinc_set_hash: anyOf: - type: string - type: 'null' title: Loinc Set Hash labs: anyOf: - items: $ref: '#/components/schemas/CompendiumSearchLabs' type: array - type: 'null' title: Labs include_related: type: boolean title: Include Related default: true limit: type: integer title: Limit default: 3 type: object required: - mode title: SearchCompendiumBody SearchCompendiumResponse: properties: mode: $ref: '#/components/schemas/SearchMode' description: ℹ️ This enum is non-exhaustive. selected_canonical: anyOf: - $ref: '#/components/schemas/CanonicalCandidate' - type: 'null' canonical_candidates: items: $ref: '#/components/schemas/CanonicalCandidate' type: array title: Canonical Candidates per_lab: additionalProperties: items: $ref: '#/components/schemas/PerLabCandidate' type: array type: object title: Per Lab related: items: $ref: '#/components/schemas/RelatedCandidate' type: array title: Related type: object required: - mode title: SearchCompendiumResponse SearchMode: type: string enum: - canonical - crosswalk title: SearchMode description: ℹ️ This enum is non-exhaustive. Sex: type: string enum: - female - male - other title: Sex description: ℹ️ This enum is non-exhaustive. SexualActivityEntry: properties: date: type: string format: date title: Date protection_used: anyOf: - type: boolean - type: 'null' title: Protection Used type: object required: - date title: SexualActivityEntry SexualOrientation: type: string enum: - lesbian_gay_or_homosexual - heterosexual_or_straight - bisexual - dont_know - other title: SexualOrientation description: ℹ️ This enum is non-exhaustive. ShippingAddress: properties: receiver_name: type: string title: Receiver Name first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip: type: string title: Zip country: type: string title: Country phone_number: type: string title: Phone Number type: object required: - receiver_name - first_line - city - state - zip - country - phone_number title: ShippingAddress ShippingAddressWithValidation: properties: receiver_name: type: string title: Receiver Name first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip: type: string pattern: ^\d{5}(-\d{4})?$ title: Zip country: type: string title: Country phone_number: type: string title: Phone Number type: object required: - receiver_name - first_line - city - state - zip - country - phone_number title: ShippingAddressWithValidation SimulationFlags: properties: interpretation: $ref: '#/components/schemas/Interpretation' default: normal description: ℹ️ This enum is non-exhaustive. result_types: anyOf: - items: $ref: '#/components/schemas/ResultType' type: array - type: 'null' title: Result Types has_missing_results: anyOf: - type: boolean - type: 'null' title: Has Missing Results type: object title: SimulationFlags SingleHistoricalPullStatistics: properties: status: $ref: '#/components/schemas/HistoricalPullStatus' description: ℹ️ This enum is non-exhaustive. range_start: anyOf: - type: string format: date-time - type: 'null' title: Range Start range_end: anyOf: - type: string format: date-time - type: 'null' title: Range End timeline: $ref: '#/components/schemas/HistoricalPullTimeline' days_with_data: type: integer title: Days With Data default: 0 release: type: string title: Release trace_id: anyOf: - type: string - type: 'null' title: Trace Id error_details: anyOf: - $ref: '#/components/schemas/HistoricalPullRetriableErrorDetails' - $ref: '#/components/schemas/HistoricalPullNonRetriableErrorDetails' - type: 'null' title: Error Details description: ℹ️ This enum is non-exhaustive. type: object required: - status - timeline - release title: SingleHistoricalPullStatistics SingleProviderHistoricalPullResponse: properties: pulled: additionalProperties: $ref: '#/components/schemas/SingleHistoricalPullStatistics' propertyNames: $ref: '#/components/schemas/Resource' type: object title: Pulled not_pulled: items: $ref: '#/components/schemas/Resource' type: array title: Not Pulled type: object required: - pulled - not_pulled title: SingleProviderHistoricalPullResponse SingleResourceStatistics: properties: last_attempt: anyOf: - $ref: '#/components/schemas/LastAttempt' - type: 'null' oldest_data: anyOf: - type: string format: date-time - type: 'null' title: Oldest Data newest_data: anyOf: - type: string format: date-time - type: 'null' title: Newest Data sent_count: anyOf: - type: integer - type: 'null' title: Sent Count type: object title: SingleResourceStatistics SingleUserHistoricalPullResponse: properties: user_id: type: string format: uuid title: User Id provider: additionalProperties: $ref: '#/components/schemas/SingleProviderHistoricalPullResponse' propertyNames: $ref: '#/components/schemas/Providers' type: object title: Provider type: object required: - user_id - provider title: SingleUserHistoricalPullResponse SingleUserResourceResponse: properties: user_id: type: string format: uuid title: User Id provider: additionalProperties: additionalProperties: $ref: '#/components/schemas/SingleResourceStatistics' propertyNames: $ref: '#/components/schemas/Resource' type: object propertyNames: $ref: '#/components/schemas/Providers' type: object title: Provider type: object required: - user_id - provider title: SingleUserResourceResponse SleepColumnExpr: properties: sleep: type: string enum: - id - session_start - session_end - state - type - duration_second - stage_asleep_second - stage_awake_second - stage_light_second - stage_rem_second - stage_deep_second - stage_unknown_second - latency_second - heart_rate_minimum - heart_rate_mean - heart_rate_maximum - heart_rate_dip - heart_rate_resting - efficiency - hrv_mean_rmssd - hrv_mean_sdnn - skin_temperature - skin_temperature_delta - respiratory_rate - score - recovery_readiness_score - source_type - source_provider - source_app_id - source_device_id - time_zone title: Sleep description: ℹ️ This enum is non-exhaustive. type: object required: - sleep title: SleepColumnExpr SleepScoreValueMacroExpr: properties: value_macro: type: string const: sleep_score title: Value Macro version: type: string const: automatic title: Version default: automatic type: object required: - value_macro title: SleepScoreValueMacroExpr SleepSummaryState: type: string enum: - tentative - confirmed title: SleepSummaryState description: ℹ️ This enum is non-exhaustive. SleepType: type: string enum: - long_sleep - short_sleep - acknowledged_nap - unknown title: SleepType description: ℹ️ This enum is non-exhaustive. Source: properties: name: type: string title: Name slug: type: string title: Slug description: type: string title: Description logo: type: string title: Logo group: anyOf: - type: string - type: 'null' title: Group oauth_url: anyOf: - type: string - type: 'null' title: Oauth Url auth_type: anyOf: - $ref: '#/components/schemas/SourceAuthType' - type: 'null' default: oauth description: ℹ️ This enum is non-exhaustive. source_type: anyOf: - $ref: '#/components/schemas/SourceType' - type: 'null' default: device description: ℹ️ This enum is non-exhaustive. is_active: anyOf: - type: boolean - type: 'null' title: Is Active default: true backfill_num_days: anyOf: - type: integer - type: 'null' title: Backfill Num Days id: type: integer title: Id type: object required: - name - slug - description - logo - id title: Provider example: auth_type: oauth description: Garmin Watches id: 1 logo: https://garmin.com name: Garmin oauth_url: https://garmin_aouth_url.com slug: garmin SourceAuthType: type: string enum: - oauth - team_oauth - sdk - password - email - app - '' title: SourceAuthType x-fern-enum: ? '' : name: Empty description: ℹ️ This enum is non-exhaustive. SourceColumnExpr: properties: source: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport title: Source description: ℹ️ This enum is non-exhaustive. type: object required: - source title: SourceColumnExpr SourceLink: properties: id: type: integer title: Id name: type: string title: Name slug: type: string title: Slug description: type: string title: Description logo: type: string title: Logo oauth_url: anyOf: - type: string - type: 'null' title: Oauth Url auth_type: anyOf: - $ref: '#/components/schemas/SourceAuthType' - type: 'null' default: oauth description: ℹ️ This enum is non-exhaustive. form_components: additionalProperties: true type: object title: Form Components default: {} type: object required: - id - name - slug - description - logo title: SourceLink SourceType: type: string enum: - app - ble - device - lab - provider title: SourceType description: ℹ️ This enum is non-exhaustive. TeamConfig: properties: libreview: $ref: '#/components/schemas/LibreConfig' texts_enabled: type: boolean title: Texts Enabled default: false push_historical_data: type: boolean title: Push Historical Data default: false provider_raw_data: type: boolean title: Provider Raw Data default: false reject_duplicate_connection: type: boolean title: Reject Duplicate Connection default: false sdk_per_device_activity_timeseries: type: boolean title: Sdk Per Device Activity Timeseries default: false partial_webhooks_enabled: type: boolean title: Partial Webhooks Enabled default: false minor_ordering_enabled: type: boolean title: Minor Ordering Enabled default: false eds_preferences: $ref: '#/components/schemas/EventDestinationPreferences' event_type_prefixes: anyOf: - items: type: string type: array - type: 'null' title: Event Type Prefixes type: object required: - libreview title: TeamConfig TemperatureTimeseriesExpr: properties: timeseries: type: string enum: - body_temperature - body_temperature_delta title: Timeseries description: ℹ️ This enum is non-exhaustive. field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - duration - value - type: string const: sensor_location title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: TemperatureTimeseriesExpr TimeSlot: properties: booking_key: anyOf: - type: string - type: 'null' title: Booking Key start: type: string format: date-time title: Start description: Time is in UTC end: type: string format: date-time title: End description: Time is in UTC expires_at: anyOf: - type: string format: date-time - type: 'null' title: Expires At price: type: number title: Price is_priority: type: boolean title: Is Priority num_appointments_available: type: integer title: Num Appointments Available type: object required: - start - end - price - is_priority - num_appointments_available title: TimeSlot TimeseriesMetricPoint: properties: date: type: string format: date-time title: Date value: type: number title: Value all: type: number title: All type: object required: - date - value - all title: TimeseriesMetricPoint TimeseriesResource: type: string enum: - calories_active - calories_basal - distance - blood_oxygen - blood_pressure - body_fat - body_weight - body_temperature - body_temperature_delta - cholesterol - cholesterol/ldl - cholesterol/hdl - cholesterol/total - cholesterol/triglycerides - electrocardiogram_voltage - floors_climbed - glucose - heartrate - hrv - hypnogram - ige - igg - respiratory_rate - steps - stress_level - vo2_max - water - caffeine - mindfulness_minutes - afib_burden - heart_rate_alert - stand_hour - stand_duration - sleep_apnea_alert - sleep_breathing_disturbance - wheelchair_push - forced_expiratory_volume_1 - forced_vital_capacity - peak_expiratory_flow_rate - inhaler_usage - fall - uv_exposure - daylight_exposure - handwashing - basal_body_temperature - body_mass_index - lean_body_mass - waist_circumference - heart_rate_recovery_one_minute - workout_distance - workout_swimming_stroke - workout_duration - insulin_injection - carbohydrates - note title: TimeseriesResource description: ℹ️ This enum is non-exhaustive. TraceElements: type: string enum: - chromium - copper - iodine - manganese - molybdenum - selenium title: TraceElements description: ℹ️ This enum is non-exhaustive. USAddress: properties: first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line city: type: string title: City state: type: string title: State zip_code: type: string pattern: ^\d{5}(-\d{4})?$ title: Zip Code unit: anyOf: - type: string - type: 'null' title: Unit description: Deprecated. Use `second_line` instead to provide the unit number. Subject to removal after 20 Nov 2023. deprecated: true access_notes: anyOf: - type: string maxLength: 1000 - type: 'null' title: Access Notes type: object required: - first_line - city - state - zip_code title: USAddress USState: type: string enum: - AL - AK - AZ - AR - CA - CO - CT - DE - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY title: USState description: ℹ️ This enum is non-exhaustive. UTCTimestampWithTimezoneOffset: properties: timestamp: type: string format: date-time title: Timestamp timezone_offset: type: integer title: Timezone Offset type: object required: - timestamp - timezone_offset title: UTCTimestampWithTimezoneOffset UnnestExpr: properties: unnest: anyOf: - $ref: '#/components/schemas/SleepColumnExpr' - $ref: '#/components/schemas/DerivedReadinessColumnExpr' - $ref: '#/components/schemas/ActivityColumnExpr' - $ref: '#/components/schemas/WorkoutColumnExpr' - $ref: '#/components/schemas/BodyColumnExpr' - $ref: '#/components/schemas/MealColumnExpr' - $ref: '#/components/schemas/MenstrualCycleColumnExpr' - $ref: '#/components/schemas/ProfileColumnExpr' - $ref: '#/components/schemas/SleepScoreValueMacroExpr' - $ref: '#/components/schemas/ChronotypeValueMacroExpr' - $ref: '#/components/schemas/AsleepAtValueMacroExpr' - $ref: '#/components/schemas/AwakeAtValueMacroExpr' - $ref: '#/components/schemas/AwakeningsValueMacroExpr' - $ref: '#/components/schemas/UnrecognizedValueMacroExpr' - $ref: '#/components/schemas/DiscreteTimeseriesExpr' - $ref: '#/components/schemas/IntervalTimeseriesExpr' - $ref: '#/components/schemas/InsulinInjectionTimeseriesExpr' - $ref: '#/components/schemas/BloodPressureTimeseriesExpr' - $ref: '#/components/schemas/TemperatureTimeseriesExpr' - $ref: '#/components/schemas/WorkoutDurationTimeseriesExpr' - $ref: '#/components/schemas/NoteTimeseriesExpr' title: Unnest type: object required: - unnest title: UnnestExpr description: 'FROM clause variant: unnest a list column into elements.' UnrecognizedValueMacroExpr: properties: value_macro: type: string title: Value Macro type: object required: - value_macro title: UnrecognizedValueMacroExpr UpdateLabTestRequest: properties: name: anyOf: - type: string - type: 'null' title: Name active: anyOf: - type: boolean - type: 'null' title: Active type: object title: UpdateLabTestRequest UpdateOrderBody: properties: activate_by: anyOf: - type: string format: date - type: 'null' title: Activate By description: 'The date on which the order should be activated (dispatched to the lab). Must be today or a future date. Set to `null` to clear an existing scheduled date and dispatch the order immediately. Note: an order originally created for immediate processing (no `activate_by` at creation time) cannot be rescheduled — only orders that were created with an `activate_by` can have it changed or cleared.' type: object required: - activate_by title: UpdateOrderBody description: Patch body for updating a modifiable order's scheduled activation date. UserAddress: properties: first_line: type: string title: First Line second_line: anyOf: - type: string - type: 'null' title: Second Line default: '' country: type: string title: Country zip: type: string title: Zip city: type: string title: City state: type: string title: State access_notes: anyOf: - type: string - type: 'null' title: Access Notes type: object required: - first_line - country - zip - city - state title: UserAddress UserCreateBody: properties: client_user_id: type: string title: Client User Id description: A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. fallback_time_zone: anyOf: - type: string - type: 'null' title: Fallback Time Zone description: "\n Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London`\ \ or `America/Los_Angeles`).\n Used when pulling data from sources that are completely time zone agnostic (e.g.,\ \ all time is relative to UTC clock, without any time zone attributions on data points).\n " fallback_birth_date: anyOf: - type: string format: date - type: 'null' title: Fallback Birth Date description: Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age. ingestion_start: anyOf: - type: string format: date - type: 'null' title: Ingestion Start description: Starting bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). ingestion_end: anyOf: - type: string format: date - type: 'null' title: Ingestion End description: Ending bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). type: object required: - client_user_id title: UserCreateBody UserHistoricalPullsResponse: properties: data: items: $ref: '#/components/schemas/SingleUserHistoricalPullResponse' type: array title: Data next: anyOf: - type: string - type: 'null' title: Next deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. type: object required: - data - next - next_cursor title: UserHistoricalPullsResponse example: data: - provider: fitbit: not_pulled: - blood_oxygen pulled: activity: days_with_data: 70 range_end: '2023-10-24T00:00:00+00:00' range_start: '2023-07-24T00:00:00+00:00' release: 0.0.0-dev.cd0e262 status: success timeline: ended_at: '2023-10-24T13:53:59+00:00' scheduled_at: '2023-10-24T13:52:51+00:00' started_at: '2023-10-24T13:52:54+00:00' trace_id: 51cc7d2d72e98ed4eb63e2b0864b39e3 sleep: days_with_data: 70 error_details: provider_rate_limit_exceeded range_end: '2023-10-24T00:00:00+00:00' range_start: '2023-07-24T00:00:00+00:00' release: 0.0.0-dev.cd0e262 status: retrying timeline: ended_at: '2023-10-24T13:53:04+00:00' scheduled_at: '2023-10-24T13:52:51+00:00' started_at: '2023-10-24T13:53:01+00:00' trace_id: 51cc7d2d72e98ed4eb63e2b0864b39e3 user_id: '' next_cursor: None UserInfo: properties: first_name: type: string title: First Name last_name: type: string title: Last Name email: type: string title: Email phone_number: type: string title: Phone Number gender: type: string title: Gender dob: type: string format: date title: Dob address: $ref: '#/components/schemas/UserAddress' medical_proxy: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' race: anyOf: - $ref: '#/components/schemas/Race' - type: 'null' description: ℹ️ This enum is non-exhaustive. ethnicity: anyOf: - $ref: '#/components/schemas/Ethnicity' - type: 'null' description: ℹ️ This enum is non-exhaustive. sexual_orientation: anyOf: - $ref: '#/components/schemas/SexualOrientation' - type: 'null' description: ℹ️ This enum is non-exhaustive. gender_identity: anyOf: - $ref: '#/components/schemas/GenderIdentity' - type: 'null' description: ℹ️ This enum is non-exhaustive. type: object required: - first_name - last_name - email - phone_number - gender - dob - address title: UserInfo UserInfoCreateRequest: properties: first_name: type: string title: First Name last_name: type: string title: Last Name email: type: string format: email title: Email phone_number: type: string title: Phone Number gender: type: string title: Gender dob: type: string format: date title: Dob address: $ref: '#/components/schemas/UserAddress' medical_proxy: anyOf: - $ref: '#/components/schemas/GuarantorDetails' - type: 'null' race: anyOf: - $ref: '#/components/schemas/Race' - type: 'null' description: ℹ️ This enum is non-exhaustive. ethnicity: anyOf: - $ref: '#/components/schemas/Ethnicity' - type: 'null' description: ℹ️ This enum is non-exhaustive. sexual_orientation: anyOf: - $ref: '#/components/schemas/SexualOrientation' - type: 'null' description: ℹ️ This enum is non-exhaustive. gender_identity: anyOf: - $ref: '#/components/schemas/GenderIdentity' - type: 'null' description: ℹ️ This enum is non-exhaustive. type: object required: - first_name - last_name - email - phone_number - gender - dob - address title: UserInfoCreateRequest UserPatchBody: properties: fallback_time_zone: anyOf: - type: string - type: 'null' title: Fallback Time Zone description: "\n Fallback time zone of the user, in the form of a valid IANA tzdatabase identifier (e.g., `Europe/London`\ \ or `America/Los_Angeles`).\n Used when pulling data from sources that are completely time zone agnostic (e.g.,\ \ all time is relative to UTC clock, without any time zone attributions on data points).\n " fallback_birth_date: anyOf: - type: string format: date - type: 'null' title: Fallback Birth Date description: Fallback date of birth of the user, in YYYY-mm-dd format. Used for calculating max heartrate for providers that don not provide users' age. ingestion_start: anyOf: - type: string format: date - type: 'null' title: Ingestion Start description: Starting bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). ingestion_end: anyOf: - type: string format: date - type: 'null' title: Ingestion End description: Ending bound for user [data ingestion bounds](https://docs.tryvital.io/wearables/providers/data-ingestion-bounds). client_user_id: anyOf: - type: string - type: 'null' title: Client User Id description: A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. type: object title: UserPatchBody UserRefreshErrorResponse: properties: success: type: boolean const: false title: Success description: Whether operation was successful or not user_id: type: string format: uuid title: User Id description: A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. error: type: string title: Error failed_sources: items: type: string type: array title: Failed Sources type: object required: - success - user_id - error title: UserRefreshErrorResponse example: error: user has no connected sources failed_sources: [] success: false user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 UserRefreshSuccessResponse: properties: success: type: boolean const: true title: Success description: Whether operation was successful or not user_id: type: string format: uuid title: User Id description: A unique ID representing the end user. Typically this will be a user ID from your application. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id. refreshed_sources: items: type: string type: array title: Refreshed Sources in_progress_sources: items: type: string type: array title: In Progress Sources failed_sources: items: type: string type: array title: Failed Sources type: object required: - success - user_id - refreshed_sources - in_progress_sources - failed_sources title: UserRefreshSuccessResponse example: failed_sources: - oura/sleep in_progress_sources: [] refreshed_sources: - withings/workouts - withings/sleep - withings/body - withings/vitals/blood_pressure - withings/activity success: true user_id: 1449752e-0d8a-40e0-9206-91ab099b2537 UserResourcesResponse: properties: data: items: $ref: '#/components/schemas/SingleUserResourceResponse' type: array title: Data next: anyOf: - type: string - type: 'null' title: Next deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. type: object required: - data - next - next_cursor title: UserResourcesResponse example: data: - provider: fitbit: activity: last_attempt: status: success timestamp: '2023-10-24T13:13:27+00:00' newest_data: '2023-10-24T00:00:00+00:00' oldest_data: '2023-06-21T00:00:00+00:00' sent_count: 231 user_id: '' UserSignInTokenResponse: properties: user_id: type: string format: uuid title: User Id sign_in_token: type: string title: Sign In Token type: object required: - user_id - sign_in_token title: UserSignInTokenResponse UserSuccessResponse: properties: success: type: boolean title: Success description: Whether operation was successful or not type: object required: - success title: UserSuccessResponse example: success: true ValidateICDCodesBody: properties: codes: items: type: string type: array title: Codes type: object required: - codes title: ValidateICDCodesBody ValidateICDCodesResponse: properties: valid: type: boolean title: Valid errors: items: type: string type: array title: Errors violations: items: $ref: '#/components/schemas/ICDExcludesViolation' type: array title: Violations warnings: items: $ref: '#/components/schemas/ICDExcludesWarning' type: array title: Warnings type: object required: - valid - errors - violations - warnings title: ValidateICDCodesResponse ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError VitalSleepStage: type: integer enum: - -1 - 1 - 2 - 3 - 4 - 5 title: VitalSleepStage description: ℹ️ This enum is non-exhaustive. VitalTokenCreatedResponse: properties: code: type: string pattern: ^(sk|pk)(eu|us)([\da-f]{8}) title: Code exchange_url: type: string pattern: ^tryvital\:\/\/tryvital\?code\=(sk|pk)(eu|us)([\da-f]{8})$ title: Exchange Url expires_at: type: string format: date-time title: Expires At type: object required: - code - exchange_url - expires_at title: VitalTokenCreatedResponse Vitamins: type: string enum: - vitamin_a - vitamin_b1 - riboflavin - niacin - pantothenic_acid - vitamin_b6 - biotin - vitamin_b12 - vitamin_c - vitamin_d - vitamin_e - vitamin_k - folic_acid title: Vitamins description: ℹ️ This enum is non-exhaustive. WorkoutColumnExpr: properties: workout: type: string enum: - session_start - session_end - title - sport_name - sport_slug - duration_active_second - heart_rate_mean - heart_rate_minimum - heart_rate_maximum - heart_rate_zone_1 - heart_rate_zone_2 - heart_rate_zone_3 - heart_rate_zone_4 - heart_rate_zone_5 - heart_rate_zone_6 - distance_meter - calories - elevation_gain_meter - elevation_maximum_meter - elevation_minimum_meter - speed_mean - speed_maximum - power_source - power_mean - power_maximum - power_weighted_mean - steps - map_polyline - map_summary_polyline - source_type - source_provider - source_app_id - source_device_id - external_id - time_zone title: Workout description: ℹ️ This enum is non-exhaustive. type: object required: - workout title: WorkoutColumnExpr WorkoutDurationTimeseriesExpr: properties: timeseries: type: string const: workout_duration title: Timeseries field: anyOf: - type: string enum: - source_provider - source_type - type: string const: source_app_id - type: string enum: - source_workout_id - source_sport - type: string enum: - timezone_offset - type - type: string enum: - duration - value - type: string const: intensity title: Field description: ℹ️ This enum is non-exhaustive. type: object required: - timeseries - field title: WorkoutDurationTimeseriesExpr _ClientFacingSampleGroupingKeys: prefixItems: - type: string enum: - unknown - phone - watch - app - multiple_sources - fingerprick - cuff - manual_scan - automatic - insulin_pump - scale - chest_strap - ring - lab - exercise_machine - earphone title: Source Type - anyOf: - type: string format: uuid - type: 'null' title: Workout Id - anyOf: - type: string - type: 'null' title: Sport - anyOf: - type: string format: uuid - type: 'null' title: Source Device Id type: array maxItems: 4 minItems: 1 api__api_v1__endpoints__vital_api__lab_testing__orders__helpers__AppointmentCancelRequest: properties: cancellation_reason_id: type: string format: uuid4 title: Cancellation Reason Id notes: anyOf: - type: string - type: 'null' title: Notes type: object required: - cancellation_reason_id title: AppointmentCancelRequest vital_core__clients__lab_test__getlabs__schema__AppointmentCancelRequest: properties: cancellationReasonId: type: string format: uuid4 title: Cancellationreasonid note: anyOf: - type: string - type: 'null' title: Note type: object required: - cancellationReasonId title: AppointmentCancelRequest vital_core__schemas__db_schemas__lab_test__health_insurance__PersonDetails: properties: first_name: type: string title: First Name last_name: type: string title: Last Name address: $ref: '#/components/schemas/Address' phone_number: type: string title: Phone Number phone_type: type: string title: Phone Type default: Mobile type: object required: - first_name - last_name - address - phone_number title: PersonDetails vital_core__schemas__db_schemas__lab_test__insurance__PersonDetails: properties: first_name: type: string title: First Name last_name: type: string title: Last Name gender: $ref: '#/components/schemas/Gender' description: ℹ️ This enum is non-exhaustive. address: $ref: '#/components/schemas/Address' dob: type: string format: date title: Dob email: type: string title: Email phone_number: type: string title: Phone Number type: object required: - first_name - last_name - gender - address - dob - email - phone_number title: PersonDetails GroupedWorkoutSwimmingStrokeResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWorkoutSwimmingStroke' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWorkoutSwimmingStrokeResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 37 source: provider: oura type: ring GroupedWorkoutDistanceResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWorkoutDistance' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWorkoutDistanceResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: m value: 37 source: provider: oura type: ring GroupedHeartRateRecoveryOneMinuteResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHeartRateRecoveryOneMinute' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHeartRateRecoveryOneMinuteResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 37 source: provider: oura type: ring GroupedWaistCircumferenceResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWaistCircumference' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWaistCircumferenceResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: cm value: 90 source: provider: oura type: ring GroupedLeanBodyMassResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedLeanBodyMass' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedLeanBodyMassResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: kg value: 50 source: provider: oura type: ring GroupedBodyMassIndexResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBodyMassIndex' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBodyMassIndexResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: index value: 21 source: provider: oura type: ring GroupedBasalBodyTemperatureResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBasalBodyTemperature' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBasalBodyTemperatureResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: °C value: 36.7 source: provider: oura type: ring GroupedHandwashingResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHandwashing' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHandwashingResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 source: provider: oura type: ring GroupedDaylightExposureResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedDaylightExposure' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedDaylightExposureResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: min value: 45 source: provider: oura type: ring GroupedUVExposureResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedUVExposure' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedUVExposureResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: index value: 5 source: provider: oura type: ring GroupedFallResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedFall' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedFallResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 3 source: provider: oura type: ring GroupedInhalerUsageResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedInhalerUsage' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedInhalerUsageResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 2 source: provider: oura type: ring GroupedPeakExpiratoryFlowRateResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedPeakExpiratoryFlowRate' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedPeakExpiratoryFlowRateResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L/min value: 450 source: provider: oura type: ring GroupedForcedVitalCapacityResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedForcedVitalCapacity' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedForcedVitalCapacityResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L value: 4.2 source: provider: oura type: ring GroupedForcedExpiratoryVolume1Response: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedForcedExpiratoryVolume1' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedForcedExpiratoryVolume1Response example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: L value: 3.5 source: provider: oura type: ring GroupedWheelchairPushResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWheelchairPush' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWheelchairPushResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 52 source: provider: oura type: ring GroupedSleepBreathingDisturbanceResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedSleepBreathingDisturbance' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedSleepBreathingDisturbanceResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' type: elevated unit: count value: 12 source: provider: oura type: ring GroupedSleepApneaAlertResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedSleepApneaAlert' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedSleepApneaAlertResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 source: provider: oura type: ring GroupedStandDurationResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedStandDuration' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedStandDurationResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: min value: 15 source: provider: oura type: ring GroupedStandHourResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedStandHour' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedStandHourResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' timestamp: '2023-02-13T14:30:52+00:00' unit: count value: 1 source: provider: oura type: ring GroupedHeartRateAlertResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHeartRateAlert' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHeartRateAlertResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' type: irregular_rhythm unit: count value: 1 source: provider: oura type: ring GroupedAFibBurdenResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedAFibBurden' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedAFibBurdenResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' unit: '%' value: 3 source: provider: oura type: ring GroupedWorkoutDurationResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWorkoutDuration' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWorkoutDurationResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' intensity: medium start: '2023-02-13T14:30:52+00:00' unit: min value: 48 source: provider: oura type: ring GroupedVO2MaxResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedVO2Max' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedVO2MaxResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: mL/kg/min value: 48 source: provider: oura type: ring GroupedStressLevelResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedStressLevel' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedStressLevelResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 35 source: provider: oura type: ring GroupedMindfulnessMinutesResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedMindfulnessMinutes' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedMindfulnessMinutesResponse example: groups: oura: - data: - end: '2026-05-20T13:48:41.621257+00:00' start: '2023-02-13T14:57:24+00:00' unit: min value: 42 source: provider: oura type: ring GroupedCaffeineResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedCaffeine' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedCaffeineResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: g value: 42 source: provider: oura type: ring GroupedWaterResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedWater' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedWaterResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: ml value: 400 source: provider: oura type: ring GroupedStepsResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedSteps' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedStepsResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: count value: 123 source: provider: oura type: ring GroupedFloorsClimbedResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedFloorsClimbed' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedFloorsClimbedResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: count value: 2 source: provider: oura type: ring GroupedDistanceResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedDistance' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedDistanceResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: m value: 5.6 source: provider: oura type: ring GroupedCaloriesBasalResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedCaloriesBasal' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedCaloriesBasalResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: kcal value: 22.8 source: provider: oura type: ring GroupedCaloriesActiveResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedCaloriesActive' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedCaloriesActiveResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: kcal value: 184 source: provider: oura type: ring GroupedRespiratoryRateResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedRespiratoryRate' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedRespiratoryRateResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: bpm value: 15.5 source: provider: oura type: ring GroupedNoteResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedNote' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedNoteResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' tags: - food - exercise unit: text value: Lorem ipsum dolor sit amet source: provider: oura type: ring GroupedInsulinInjectionResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedInsulinInjection' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedInsulinInjectionResponse example: groups: oura: - data: - bolus_purpose: correction delivery_form: extended delivery_mode: bolus end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' type: rapid_acting unit: unit value: 2.5 source: provider: oura type: ring GroupedIgeResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedIge' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedIgeResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' type: baha_grass unit: FSU value: 70 source: provider: oura type: ring GroupedIggResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedIgg' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedIggResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' type: dairy unit: FSU value: 12 source: provider: oura type: ring GroupedHypnogramResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHypnogram' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHypnogramResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' start: '2023-02-13T14:30:52+00:00' unit: stage value: 1 source: provider: oura type: ring GroupedHRVResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHRV' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHRVResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: rmssd value: 48 source: provider: oura type: ring GroupedHeartRateResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedHeartRate' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedHeartRateResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: bpm value: 70 source: provider: oura type: ring GroupedGlucoseResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedGlucose' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedGlucoseResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' type: automatic | manual_scan unit: mmol/L value: 0.5 source: provider: oura type: ring GroupedCholesterolResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedCholesterol' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedCholesterolResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/ldl unit: mmol/L value: 0.6 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/hdl unit: mmol/L value: 0.2 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/total unit: mmol/L value: 0.7 - timestamp: '2023-02-13T14:30:52+00:00' type: cholesterol/triglycerides unit: mmol/L value: 0.7 source: provider: oura type: ring GroupedCarbohydratesResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedCarbohydrates' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedCarbohydratesResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' start: '2023-02-13T14:30:52+00:00' unit: g value: 30 source: provider: oura type: ring GroupedBodyTemperatureDeltaResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBodyTemperatureDelta' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBodyTemperatureDeltaResponse example: groups: oura: - data: - end: '2023-02-13T14:57:24+00:00' sensor_location: wrist start: '2023-02-13T14:30:52+00:00' unit: °C value: -1 source: provider: oura type: ring GroupedBodyTemperatureResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBodyTemperature' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBodyTemperatureResponse example: groups: oura: - data: - end: '2023-02-13T14:30:52+00:00' sensor_location: eardrum start: '2023-02-13T14:30:52+00:00' unit: °C value: 65 source: provider: oura type: ring GroupedBodyWeightResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBodyWeight' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBodyWeightResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: kg value: 65 source: provider: oura type: ring GroupedBodyFatResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBodyFat' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBodyFatResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 50 source: provider: oura type: ring GroupedBloodOxygenResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBloodOxygen' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBloodOxygenResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' unit: '%' value: 98 source: provider: oura type: ring GroupedElectrocardiogramVoltageResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedElectrocardiogramVoltage' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedElectrocardiogramVoltageResponse example: groups: oura: - data: - timestamp: '2023-02-13T14:30:52+00:00' type: lead_1 unit: mV value: -373 source: provider: oura type: ring GroupedBloodPressureResponse: properties: groups: additionalProperties: items: $ref: '#/components/schemas/GroupedBloodPressure' type: array type: object title: Groups description: For each matching provider or lab, a list of grouped timeseries values. next: anyOf: - type: string - type: 'null' title: Next description: The cursor for fetching the next page, or `null` if there is no more data. deprecated: true next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor description: The cursor for fetching the next page, or `null` if there is no more data. type: object required: - groups title: GroupedBloodPressureResponse example: groups: oura: - data: - diastolic: 75 systolic: 125 timestamp: '2026-05-20T13:43:41+00:00' unit: mmHg source: provider: oura type: ring GroupedWorkoutSwimmingStroke: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeSample' type: array type: object required: - source - data title: GroupedWorkoutSwimmingStroke GroupedWorkoutDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDistanceSample' type: array type: object required: - source - data title: GroupedWorkoutDistance GroupedHeartRateRecoveryOneMinute: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteSample' type: array type: object required: - source - data title: GroupedHeartRateRecoveryOneMinute GroupedWaistCircumference: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaistCircumferenceSample' type: array type: object required: - source - data title: GroupedWaistCircumference GroupedLeanBodyMass: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingLeanBodyMassSample' type: array type: object required: - source - data title: GroupedLeanBodyMass GroupedBodyMassIndex: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyMassIndexSample' type: array type: object required: - source - data title: GroupedBodyMassIndex GroupedBasalBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBasalBodyTemperature GroupedHandwashing: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHandwashingSample' type: array type: object required: - source - data title: GroupedHandwashing GroupedDaylightExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDaylightExposureSample' type: array type: object required: - source - data title: GroupedDaylightExposure GroupedUVExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingUVExposureSample' type: array type: object required: - source - data title: GroupedUVExposure GroupedFall: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFallSample' type: array type: object required: - source - data title: GroupedFall GroupedInhalerUsage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInhalerUsageSample' type: array type: object required: - source - data title: GroupedInhalerUsage GroupedPeakExpiratoryFlowRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateSample' type: array type: object required: - source - data title: GroupedPeakExpiratoryFlowRate GroupedForcedVitalCapacity: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedVitalCapacitySample' type: array type: object required: - source - data title: GroupedForcedVitalCapacity GroupedForcedExpiratoryVolume1: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1Sample' type: array type: object required: - source - data title: GroupedForcedExpiratoryVolume1 GroupedWheelchairPush: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWheelchairPushSample' type: array type: object required: - source - data title: GroupedWheelchairPush GroupedSleepBreathingDisturbance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceSample' type: array type: object required: - source - data title: GroupedSleepBreathingDisturbance GroupedSleepApneaAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepApneaAlertSample' type: array type: object required: - source - data title: GroupedSleepApneaAlert GroupedStandDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandDurationSample' type: array type: object required: - source - data title: GroupedStandDuration GroupedStandHour: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandHourSample' type: array type: object required: - source - data title: GroupedStandHour GroupedHeartRateAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateAlertSample' type: array type: object required: - source - data title: GroupedHeartRateAlert GroupedAFibBurden: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingAFibBurdenSample' type: array type: object required: - source - data title: GroupedAFibBurden GroupedWorkoutDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDurationSample' type: array type: object required: - source - data title: GroupedWorkoutDuration GroupedVO2Max: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingVO2MaxTimeseries' type: array type: object required: - source - data title: GroupedVO2Max GroupedStressLevel: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStressLevelTimeseries' type: array type: object required: - source - data title: GroupedStressLevel GroupedMindfulnessMinutes: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesTimeseries' type: array type: object required: - source - data title: GroupedMindfulnessMinutes GroupedCaffeine: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaffeineTimeseries' type: array type: object required: - source - data title: GroupedCaffeine GroupedWater: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaterTimeseries' type: array type: object required: - source - data title: GroupedWater GroupedSteps: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStepsTimeseries' type: array type: object required: - source - data title: GroupedSteps GroupedFloorsClimbed: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFloorsClimbedTimeseries' type: array type: object required: - source - data title: GroupedFloorsClimbed GroupedDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDistanceTimeseries' type: array type: object required: - source - data title: GroupedDistance GroupedCaloriesBasal: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesBasalTimeseries' type: array type: object required: - source - data title: GroupedCaloriesBasal GroupedCaloriesActive: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesActiveTimeseries' type: array type: object required: - source - data title: GroupedCaloriesActive GroupedRespiratoryRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingRespiratoryRateTimeseries' type: array type: object required: - source - data title: GroupedRespiratoryRate GroupedNote: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingNoteSample' type: array type: object required: - source - data title: GroupedNote GroupedInsulinInjection: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInsulinInjectionSample' type: array type: object required: - source - data title: GroupedInsulinInjection GroupedIge: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIgeTimeseries' type: array type: object required: - source - data title: GroupedIge GroupedIgg: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIggTimeseries' type: array type: object required: - source - data title: GroupedIgg GroupedHypnogram: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHypnogramTimeseries' type: array type: object required: - source - data title: GroupedHypnogram GroupedHRV: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHRVTimeseries' type: array type: object required: - source - data title: GroupedHRV GroupedHeartRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateTimeseries' type: array type: object required: - source - data title: GroupedHeartRate GroupedGlucose: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingGlucoseTimeseries' type: array type: object required: - source - data title: GroupedGlucose GroupedCholesterol: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' type: array type: object required: - source - data title: GroupedCholesterol GroupedCarbohydrates: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCarbohydratesSample' type: array type: object required: - source - data title: GroupedCarbohydrates GroupedBodyTemperatureDelta: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaSample' type: array type: object required: - source - data title: GroupedBodyTemperatureDelta GroupedBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBodyTemperature GroupedBodyWeight: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyWeightTimeseries' type: array type: object required: - source - data title: GroupedBodyWeight GroupedBodyFat: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyFatTimeseries' type: array type: object required: - source - data title: GroupedBodyFat GroupedBloodOxygen: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodOxygenTimeseries' type: array type: object required: - source - data title: GroupedBloodOxygen GroupedElectrocardiogramVoltage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageTimeseries' type: array type: object required: - source - data title: GroupedElectrocardiogramVoltage GroupedBloodPressure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodPressureTimeseries' type: array type: object required: - source - data title: GroupedBloodPressure ClientFacingActivityChanged: properties: event_type: type: string enum: - daily.data.activity.created - daily.data.activity.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingActivity' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingActivityChanged ClientFacingSleepChanged: properties: event_type: type: string enum: - daily.data.sleep.created - daily.data.sleep.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingSleep' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepChanged ClientFacingSleepCycleChanged: properties: event_type: type: string enum: - daily.data.sleep_cycle.created - daily.data.sleep_cycle.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingSleepCycle' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepCycleChanged ClientFacingWorkoutsChanged: properties: event_type: type: string enum: - daily.data.workouts.created - daily.data.workouts.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingWorkout' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutsChanged ClientFacingWorkoutStreamChanged: properties: event_type: type: string enum: - daily.data.workout_stream.created - daily.data.workout_stream.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingShallowWorkoutStream' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutStreamChanged ClientFacingBodyChanged: properties: event_type: type: string enum: - daily.data.body.created - daily.data.body.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingBody' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyChanged ClientFacingProfileChanged: properties: event_type: type: string enum: - daily.data.profile.created - daily.data.profile.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingProfile' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingProfileChanged ClientFacingMealChanged: properties: event_type: type: string enum: - daily.data.meal.created - daily.data.meal.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/MealInDBBase_ClientFacingSource_' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMealChanged ClientFacingMenstrualCycleChanged: properties: event_type: type: string enum: - daily.data.menstrual_cycle.created - daily.data.menstrual_cycle.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingMenstrualCycle' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMenstrualCycleChanged ClientFacingElectrocardiogramChanged: properties: event_type: type: string enum: - daily.data.electrocardiogram.created - daily.data.electrocardiogram.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingElectrocardiogram' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramChanged ClientFacingActivityHistoricalPullCompleted: properties: event_type: type: string const: historical.data.activity.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingActivityHistoricalPullCompleted ClientFacingSleepHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepHistoricalPullCompleted ClientFacingSleepCycleHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep_cycle.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepCycleHistoricalPullCompleted ClientFacingWorkoutsHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workouts.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutsHistoricalPullCompleted ClientFacingWorkoutStreamHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_stream.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutStreamHistoricalPullCompleted ClientFacingBodyHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyHistoricalPullCompleted ClientFacingProfileHistoricalPullCompleted: properties: event_type: type: string const: historical.data.profile.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingProfileHistoricalPullCompleted ClientFacingMealHistoricalPullCompleted: properties: event_type: type: string const: historical.data.meal.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMealHistoricalPullCompleted ClientFacingMenstrualCycleHistoricalPullCompleted: properties: event_type: type: string const: historical.data.menstrual_cycle.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMenstrualCycleHistoricalPullCompleted ClientFacingElectrocardiogramHistoricalPullCompleted: properties: event_type: type: string const: historical.data.electrocardiogram.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramHistoricalPullCompleted ClientFacingContinuousQueryResultTableChanged: properties: event_type: type: string const: continuous_query.result_table.changed title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: items: $ref: '#/components/schemas/ContinuousQueryResultTableChanges' type: array title: Data type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingContinuousQueryResultTableChanged ClientFacingProviderConnectionCreatedEvent: properties: event_type: type: string const: provider.connection.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ProviderConnectionCreated' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingProviderConnectionCreatedEvent ClientFacingProviderConnectionErrorEvent: properties: event_type: type: string const: provider.connection.error title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ProviderConnectionError' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingProviderConnectionErrorEvent ClientFacingDeviceChanged: properties: event_type: type: string enum: - provider.device.created - provider.device.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingDevice' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDeviceChanged ClientFacingOrderChanged: properties: event_type: type: string enum: - labtest.order.created - labtest.order.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingOrder' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingOrderChanged ClientFacingAppointmentChanged: properties: event_type: type: string enum: - labtest.appointment.created - labtest.appointment.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingAppointment' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingAppointmentChanged ClientFacingCriticalResultIdentified: properties: event_type: type: string const: labtest.result.critical title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ClientFacingCriticalResult' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCriticalResultIdentified ClientFacingLabReportParsingJobCreatedEvent: properties: event_type: type: string const: lab_report.parsing_job.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ParsingJob' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLabReportParsingJobCreatedEvent ClientFacingLabReportParsingJobUpdatedEvent: properties: event_type: type: string const: lab_report.parsing_job.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/ParsingJob' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLabReportParsingJobUpdatedEvent ClientFacingCaloriesActiveChanged: properties: event_type: type: string enum: - daily.data.calories_active.created - daily.data.calories_active.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaloriesActive' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesActiveChanged ClientFacingCaloriesActiveHistoricalPullCompleted: properties: event_type: type: string const: historical.data.calories_active.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesActiveHistoricalPullCompleted ClientFacingCaloriesBasalChanged: properties: event_type: type: string enum: - daily.data.calories_basal.created - daily.data.calories_basal.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaloriesBasal' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesBasalChanged ClientFacingCaloriesBasalHistoricalPullCompleted: properties: event_type: type: string const: historical.data.calories_basal.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesBasalHistoricalPullCompleted ClientFacingBloodPressureChanged: properties: event_type: type: string enum: - daily.data.blood_pressure.created - daily.data.blood_pressure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBloodPressure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodPressureChanged ClientFacingBloodPressureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.blood_pressure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodPressureHistoricalPullCompleted ClientFacingBloodOxygenChanged: properties: event_type: type: string enum: - daily.data.blood_oxygen.created - daily.data.blood_oxygen.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBloodOxygen' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodOxygenChanged ClientFacingBloodOxygenHistoricalPullCompleted: properties: event_type: type: string const: historical.data.blood_oxygen.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodOxygenHistoricalPullCompleted ClientFacingWeightChanged: properties: event_type: type: string enum: - daily.data.weight.created - daily.data.weight.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyWeight' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWeightChanged ClientFacingWeightHistoricalPullCompleted: properties: event_type: type: string const: historical.data.weight.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWeightHistoricalPullCompleted ClientFacingFatChanged: properties: event_type: type: string enum: - daily.data.fat.created - daily.data.fat.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyFat' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFatChanged ClientFacingFatHistoricalPullCompleted: properties: event_type: type: string const: historical.data.fat.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFatHistoricalPullCompleted ClientFacingBodyTemperatureChanged: properties: event_type: type: string enum: - daily.data.body_temperature.created - daily.data.body_temperature.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyTemperature' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureChanged ClientFacingBodyTemperatureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_temperature.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureHistoricalPullCompleted ClientFacingBodyTemperatureDeltaChanged: properties: event_type: type: string enum: - daily.data.body_temperature_delta.created - daily.data.body_temperature_delta.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyTemperatureDelta' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureDeltaChanged ClientFacingBodyTemperatureDeltaHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_temperature_delta.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureDeltaHistoricalPullCompleted ClientFacingCaffeineChanged: properties: event_type: type: string enum: - daily.data.caffeine.created - daily.data.caffeine.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaffeine' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaffeineChanged ClientFacingCaffeineHistoricalPullCompleted: properties: event_type: type: string const: historical.data.caffeine.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaffeineHistoricalPullCompleted ClientFacingCholesterolChanged: properties: event_type: type: string enum: - daily.data.cholesterol.created - daily.data.cholesterol.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCholesterol' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCholesterolChanged ClientFacingCholesterolHistoricalPullCompleted: properties: event_type: type: string const: historical.data.cholesterol.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCholesterolHistoricalPullCompleted ClientFacingDistanceChanged: properties: event_type: type: string enum: - daily.data.distance.created - daily.data.distance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedDistance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDistanceChanged ClientFacingDistanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.distance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDistanceHistoricalPullCompleted ClientFacingFloorsClimbedChanged: properties: event_type: type: string enum: - daily.data.floors_climbed.created - daily.data.floors_climbed.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedFloorsClimbed' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFloorsClimbedChanged ClientFacingFloorsClimbedHistoricalPullCompleted: properties: event_type: type: string const: historical.data.floors_climbed.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFloorsClimbedHistoricalPullCompleted ClientFacingGlucoseChanged: properties: event_type: type: string enum: - daily.data.glucose.created - daily.data.glucose.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedGlucose' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingGlucoseChanged ClientFacingGlucoseHistoricalPullCompleted: properties: event_type: type: string const: historical.data.glucose.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingGlucoseHistoricalPullCompleted ClientFacingHeartrateChanged: properties: event_type: type: string enum: - daily.data.heartrate.created - daily.data.heartrate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartrateChanged ClientFacingHeartrateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heartrate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartrateHistoricalPullCompleted ClientFacingHrvChanged: properties: event_type: type: string enum: - daily.data.hrv.created - daily.data.hrv.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHRV' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHrvChanged ClientFacingHrvHistoricalPullCompleted: properties: event_type: type: string const: historical.data.hrv.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHrvHistoricalPullCompleted ClientFacingIgeChanged: properties: event_type: type: string enum: - daily.data.ige.created - daily.data.ige.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedIge' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIgeChanged ClientFacingIgeHistoricalPullCompleted: properties: event_type: type: string const: historical.data.ige.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIgeHistoricalPullCompleted ClientFacingIggChanged: properties: event_type: type: string enum: - daily.data.igg.created - daily.data.igg.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedIgg' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIggChanged ClientFacingIggHistoricalPullCompleted: properties: event_type: type: string const: historical.data.igg.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIggHistoricalPullCompleted ClientFacingMindfulnessMinutesChanged: properties: event_type: type: string enum: - daily.data.mindfulness_minutes.created - daily.data.mindfulness_minutes.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedMindfulnessMinutes' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMindfulnessMinutesChanged ClientFacingMindfulnessMinutesHistoricalPullCompleted: properties: event_type: type: string const: historical.data.mindfulness_minutes.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMindfulnessMinutesHistoricalPullCompleted ClientFacingRespiratoryRateChanged: properties: event_type: type: string enum: - daily.data.respiratory_rate.created - daily.data.respiratory_rate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedRespiratoryRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingRespiratoryRateChanged ClientFacingRespiratoryRateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.respiratory_rate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingRespiratoryRateHistoricalPullCompleted ClientFacingStepsChanged: properties: event_type: type: string enum: - daily.data.steps.created - daily.data.steps.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSteps' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStepsChanged ClientFacingStepsHistoricalPullCompleted: properties: event_type: type: string const: historical.data.steps.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStepsHistoricalPullCompleted ClientFacingStressLevelChanged: properties: event_type: type: string enum: - daily.data.stress_level.created - daily.data.stress_level.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStressLevel' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStressLevelChanged ClientFacingStressLevelHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stress_level.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStressLevelHistoricalPullCompleted ClientFacingVo2MaxChanged: properties: event_type: type: string enum: - daily.data.vo2_max.created - daily.data.vo2_max.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedVO2Max' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingVo2MaxChanged ClientFacingVo2MaxHistoricalPullCompleted: properties: event_type: type: string const: historical.data.vo2_max.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingVo2MaxHistoricalPullCompleted ClientFacingWaterChanged: properties: event_type: type: string enum: - daily.data.water.created - daily.data.water.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWater' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaterChanged ClientFacingWaterHistoricalPullCompleted: properties: event_type: type: string const: historical.data.water.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaterHistoricalPullCompleted ClientFacingElectrocardiogramVoltageChanged: properties: event_type: type: string enum: - daily.data.electrocardiogram_voltage.created - daily.data.electrocardiogram_voltage.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedElectrocardiogramVoltage' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramVoltageChanged ClientFacingElectrocardiogramVoltageHistoricalPullCompleted: properties: event_type: type: string const: historical.data.electrocardiogram_voltage.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramVoltageHistoricalPullCompleted ClientFacingAfibBurdenChanged: properties: event_type: type: string enum: - daily.data.afib_burden.created - daily.data.afib_burden.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedAFibBurden' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingAfibBurdenChanged ClientFacingAfibBurdenHistoricalPullCompleted: properties: event_type: type: string const: historical.data.afib_burden.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingAfibBurdenHistoricalPullCompleted ClientFacingHeartRateAlertChanged: properties: event_type: type: string enum: - daily.data.heart_rate_alert.created - daily.data.heart_rate_alert.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRateAlert' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateAlertChanged ClientFacingHeartRateAlertHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heart_rate_alert.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateAlertHistoricalPullCompleted ClientFacingWorkoutDurationChanged: properties: event_type: type: string enum: - daily.data.workout_duration.created - daily.data.workout_duration.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutDuration' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDurationChanged ClientFacingWorkoutDurationHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_duration.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDurationHistoricalPullCompleted ClientFacingInsulinInjectionChanged: properties: event_type: type: string enum: - daily.data.insulin_injection.created - daily.data.insulin_injection.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedInsulinInjection' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInsulinInjectionChanged ClientFacingInsulinInjectionHistoricalPullCompleted: properties: event_type: type: string const: historical.data.insulin_injection.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInsulinInjectionHistoricalPullCompleted ClientFacingCarbohydratesChanged: properties: event_type: type: string enum: - daily.data.carbohydrates.created - daily.data.carbohydrates.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCarbohydrates' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCarbohydratesChanged ClientFacingCarbohydratesHistoricalPullCompleted: properties: event_type: type: string const: historical.data.carbohydrates.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCarbohydratesHistoricalPullCompleted ClientFacingNoteChanged: properties: event_type: type: string enum: - daily.data.note.created - daily.data.note.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedNote' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingNoteChanged ClientFacingNoteHistoricalPullCompleted: properties: event_type: type: string const: historical.data.note.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingNoteHistoricalPullCompleted ClientFacingStandHourChanged: properties: event_type: type: string enum: - daily.data.stand_hour.created - daily.data.stand_hour.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStandHour' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandHourChanged ClientFacingStandHourHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stand_hour.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandHourHistoricalPullCompleted ClientFacingStandDurationChanged: properties: event_type: type: string enum: - daily.data.stand_duration.created - daily.data.stand_duration.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStandDuration' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandDurationChanged ClientFacingStandDurationHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stand_duration.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandDurationHistoricalPullCompleted ClientFacingSleepApneaAlertChanged: properties: event_type: type: string enum: - daily.data.sleep_apnea_alert.created - daily.data.sleep_apnea_alert.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSleepApneaAlert' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepApneaAlertChanged ClientFacingSleepApneaAlertHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep_apnea_alert.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepApneaAlertHistoricalPullCompleted ClientFacingSleepBreathingDisturbanceChanged: properties: event_type: type: string enum: - daily.data.sleep_breathing_disturbance.created - daily.data.sleep_breathing_disturbance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSleepBreathingDisturbance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepBreathingDisturbanceChanged ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep_breathing_disturbance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted ClientFacingWheelchairPushChanged: properties: event_type: type: string enum: - daily.data.wheelchair_push.created - daily.data.wheelchair_push.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWheelchairPush' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWheelchairPushChanged ClientFacingWheelchairPushHistoricalPullCompleted: properties: event_type: type: string const: historical.data.wheelchair_push.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWheelchairPushHistoricalPullCompleted ClientFacingForcedExpiratoryVolume1Changed: properties: event_type: type: string enum: - daily.data.forced_expiratory_volume_1.created - daily.data.forced_expiratory_volume_1.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedForcedExpiratoryVolume1' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedExpiratoryVolume1Changed ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted: properties: event_type: type: string const: historical.data.forced_expiratory_volume_1.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted ClientFacingForcedVitalCapacityChanged: properties: event_type: type: string enum: - daily.data.forced_vital_capacity.created - daily.data.forced_vital_capacity.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedForcedVitalCapacity' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedVitalCapacityChanged ClientFacingForcedVitalCapacityHistoricalPullCompleted: properties: event_type: type: string const: historical.data.forced_vital_capacity.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedVitalCapacityHistoricalPullCompleted ClientFacingPeakExpiratoryFlowRateChanged: properties: event_type: type: string enum: - daily.data.peak_expiratory_flow_rate.created - daily.data.peak_expiratory_flow_rate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedPeakExpiratoryFlowRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingPeakExpiratoryFlowRateChanged ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.peak_expiratory_flow_rate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted ClientFacingInhalerUsageChanged: properties: event_type: type: string enum: - daily.data.inhaler_usage.created - daily.data.inhaler_usage.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedInhalerUsage' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInhalerUsageChanged ClientFacingInhalerUsageHistoricalPullCompleted: properties: event_type: type: string const: historical.data.inhaler_usage.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInhalerUsageHistoricalPullCompleted ClientFacingFallChanged: properties: event_type: type: string enum: - daily.data.fall.created - daily.data.fall.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedFall' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFallChanged ClientFacingFallHistoricalPullCompleted: properties: event_type: type: string const: historical.data.fall.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFallHistoricalPullCompleted ClientFacingUvExposureChanged: properties: event_type: type: string enum: - daily.data.uv_exposure.created - daily.data.uv_exposure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedUVExposure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingUvExposureChanged ClientFacingUvExposureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.uv_exposure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingUvExposureHistoricalPullCompleted ClientFacingDaylightExposureChanged: properties: event_type: type: string enum: - daily.data.daylight_exposure.created - daily.data.daylight_exposure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedDaylightExposure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDaylightExposureChanged ClientFacingDaylightExposureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.daylight_exposure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDaylightExposureHistoricalPullCompleted ClientFacingHandwashingChanged: properties: event_type: type: string enum: - daily.data.handwashing.created - daily.data.handwashing.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHandwashing' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHandwashingChanged ClientFacingHandwashingHistoricalPullCompleted: properties: event_type: type: string const: historical.data.handwashing.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHandwashingHistoricalPullCompleted ClientFacingBasalBodyTemperatureChanged: properties: event_type: type: string enum: - daily.data.basal_body_temperature.created - daily.data.basal_body_temperature.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBasalBodyTemperature' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBasalBodyTemperatureChanged ClientFacingBasalBodyTemperatureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.basal_body_temperature.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBasalBodyTemperatureHistoricalPullCompleted ClientFacingBodyMassIndexChanged: properties: event_type: type: string enum: - daily.data.body_mass_index.created - daily.data.body_mass_index.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyMassIndex' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyMassIndexChanged ClientFacingBodyMassIndexHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_mass_index.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyMassIndexHistoricalPullCompleted ClientFacingLeanBodyMassChanged: properties: event_type: type: string enum: - daily.data.lean_body_mass.created - daily.data.lean_body_mass.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedLeanBodyMass' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLeanBodyMassChanged ClientFacingLeanBodyMassHistoricalPullCompleted: properties: event_type: type: string const: historical.data.lean_body_mass.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLeanBodyMassHistoricalPullCompleted ClientFacingWaistCircumferenceChanged: properties: event_type: type: string enum: - daily.data.waist_circumference.created - daily.data.waist_circumference.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWaistCircumference' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaistCircumferenceChanged ClientFacingWaistCircumferenceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.waist_circumference.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaistCircumferenceHistoricalPullCompleted ClientFacingHeartRateRecoveryOneMinuteChanged: properties: event_type: type: string enum: - daily.data.heart_rate_recovery_one_minute.created - daily.data.heart_rate_recovery_one_minute.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRateRecoveryOneMinute' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateRecoveryOneMinuteChanged ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heart_rate_recovery_one_minute.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted ClientFacingWorkoutDistanceChanged: properties: event_type: type: string enum: - daily.data.workout_distance.created - daily.data.workout_distance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutDistance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDistanceChanged ClientFacingWorkoutDistanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_distance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDistanceHistoricalPullCompleted ClientFacingWorkoutSwimmingStrokeChanged: properties: event_type: type: string enum: - daily.data.workout_swimming_stroke.created - daily.data.workout_swimming_stroke.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutSwimmingStroke' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutSwimmingStrokeChanged ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_swimming_stroke.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted securitySchemes: apiKeyAuth: type: apiKey in: header name: x-vital-api-key description: Vital Team API Key security: - apiKeyAuth: [] servers: - url: https://api.us.junction.com x-fern-server-name: Production - url: https://api.eu.junction.com x-fern-server-name: ProductionEU - url: https://api.sandbox.us.junction.com x-fern-server-name: Sandbox - url: https://api.sandbox.eu.junction.com x-fern-server-name: SandboxEU