openapi: 3.1.0 info: title: Vital Lab Report Parser Aggregate timeseries 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 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 security: - apiKeyAuth: [] tags: - name: timeseries paths: /v2/timeseries/sleep/{sleep_id}/stream: get: tags: - timeseries summary: Get User Sleep Stream description: Get Sleep stream for a user_id operationId: get_user_sleep_stream_v2_timeseries_sleep__sleep_id__stream_get parameters: - name: sleep_id in: path required: true schema: type: string format: uuid description: The Vital Sleep ID title: Sleep Id description: The Vital Sleep ID responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepStream' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: sleep x-fern-sdk-method-name: get_stream_by_sleep_id x-fern-availability: deprecated /v2/timeseries/workouts/{workout_id}/stream: get: tags: - timeseries summary: Get User Workouts operationId: get_user_workouts_v2_timeseries_workouts__workout_id__stream_get parameters: - name: workout_id in: path required: true schema: type: string format: uuid description: The Vital ID for the workout title: Workout Id description: The Vital ID for the workout responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ClientFacingStream' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: workouts x-fern-sdk-method-name: get_by_workout_id /v2/timeseries/{user_id}/workout_swimming_stroke/grouped: get: tags: - timeseries summary: Workout Swimming Stroke operationId: get_workout_swimming_stroke_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWorkoutSwimmingStrokeResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: workout_swimming_stroke_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/workout_distance/grouped: get: tags: - timeseries summary: Workout Distance operationId: get_workout_distance_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWorkoutDistanceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: workout_distance_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/heart_rate_recovery_one_minute/grouped: get: tags: - timeseries summary: Heart Rate Recovery One Minute operationId: get_heart_rate_recovery_one_minute_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHeartRateRecoveryOneMinuteResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: heart_rate_recovery_one_minute_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/waist_circumference/grouped: get: tags: - timeseries summary: Waist Circumference operationId: get_waist_circumference_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWaistCircumferenceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: waist_circumference_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/lean_body_mass/grouped: get: tags: - timeseries summary: Lean Body Mass operationId: get_lean_body_mass_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedLeanBodyMassResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: lean_body_mass_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/body_mass_index/grouped: get: tags: - timeseries summary: Body Mass Index operationId: get_body_mass_index_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBodyMassIndexResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_mass_index_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/basal_body_temperature/grouped: get: tags: - timeseries summary: Basal Body Temperature operationId: get_basal_body_temperature_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBasalBodyTemperatureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: basal_body_temperature_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/handwashing/grouped: get: tags: - timeseries summary: Handwashing operationId: get_handwashing_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHandwashingResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: handwashing_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/daylight_exposure/grouped: get: tags: - timeseries summary: Daylight Exposure operationId: get_daylight_exposure_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedDaylightExposureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: daylight_exposure_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/uv_exposure/grouped: get: tags: - timeseries summary: Uv Exposure operationId: get_uv_exposure_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedUVExposureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: uv_exposure_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/fall/grouped: get: tags: - timeseries summary: Fall operationId: get_fall_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedFallResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: fall_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/inhaler_usage/grouped: get: tags: - timeseries summary: Inhaler Usage operationId: get_inhaler_usage_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedInhalerUsageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: inhaler_usage_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/peak_expiratory_flow_rate/grouped: get: tags: - timeseries summary: Peak Expiratory Flow Rate operationId: get_peak_expiratory_flow_rate_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedPeakExpiratoryFlowRateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: peak_expiratory_flow_rate_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/forced_vital_capacity/grouped: get: tags: - timeseries summary: Forced Vital Capacity operationId: get_forced_vital_capacity_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedForcedVitalCapacityResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: forced_vital_capacity_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/forced_expiratory_volume_1/grouped: get: tags: - timeseries summary: Forced Expiratory Volume 1 operationId: get_forced_expiratory_volume_1_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedForcedExpiratoryVolume1Response' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: forced_expiratory_volume_1_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/wheelchair_push/grouped: get: tags: - timeseries summary: Wheelchair Push operationId: get_wheelchair_push_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWheelchairPushResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: wheelchair_push_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped: get: tags: - timeseries summary: Sleep Breathing Disturbance operationId: get_sleep_breathing_disturbance_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedSleepBreathingDisturbanceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: sleep_breathing_disturbance_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/sleep_apnea_alert/grouped: get: tags: - timeseries summary: Sleep Apnea Alert operationId: get_sleep_apnea_alert_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedSleepApneaAlertResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: sleep_apnea_alert_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/stand_duration/grouped: get: tags: - timeseries summary: Stand Duration operationId: get_stand_duration_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedStandDurationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: stand_duration_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/stand_hour/grouped: get: tags: - timeseries summary: Stand Hour operationId: get_stand_hour_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedStandHourResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: stand_hour_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/heart_rate_alert/grouped: get: tags: - timeseries summary: Heart Rate Alert operationId: get_heart_rate_alert_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHeartRateAlertResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: heart_rate_alert_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/afib_burden/grouped: get: tags: - timeseries summary: Afib Burden operationId: get_afib_burden_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedAFibBurdenResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: afib_burden_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/workout_duration/grouped: get: tags: - timeseries summary: Workout Duration operationId: get_workout_duration_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWorkoutDurationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: workout_duration_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/vo2_max/grouped: get: tags: - timeseries summary: Vo2 Max operationId: get_vo2_max_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedVO2MaxResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: vo2_max_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/stress_level/grouped: get: tags: - timeseries summary: Stress Level operationId: get_stress_level_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedStressLevelResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: stress_level_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/mindfulness_minutes/grouped: get: tags: - timeseries summary: Mindfulness Minutes operationId: get_mindfulness_minutes_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedMindfulnessMinutesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: mindfulness_minutes_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/caffeine/grouped: get: tags: - timeseries summary: Caffeine operationId: get_caffeine_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedCaffeineResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: caffeine_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/water/grouped: get: tags: - timeseries summary: Water operationId: get_water_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedWaterResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: water_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/steps/grouped: get: tags: - timeseries summary: Steps operationId: get_steps_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedStepsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: steps_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/floors_climbed/grouped: get: tags: - timeseries summary: Floors Climbed operationId: get_floors_climbed_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedFloorsClimbedResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: floors_climbed_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/distance/grouped: get: tags: - timeseries summary: Distance operationId: get_distance_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedDistanceResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: distance_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/calories_basal/grouped: get: tags: - timeseries summary: Calories Basal operationId: get_calories_basal_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedCaloriesBasalResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: calories_basal_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/calories_active/grouped: get: tags: - timeseries summary: Calories Active operationId: get_calories_active_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedCaloriesActiveResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: calories_active_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/respiratory_rate/grouped: get: tags: - timeseries summary: Respiratory Rate operationId: get_respiratory_rate_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedRespiratoryRateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: respiratory_rate_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/note/grouped: get: tags: - timeseries summary: Note operationId: get_note_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedNoteResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: note_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/insulin_injection/grouped: get: tags: - timeseries summary: Insulin Injection operationId: get_insulin_injection_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedInsulinInjectionResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: insulin_injection_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/ige/grouped: get: tags: - timeseries summary: Ige operationId: get_ige_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedIgeResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: ige_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/igg/grouped: get: tags: - timeseries summary: Igg operationId: get_igg_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedIggResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: igg_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/hypnogram/grouped: get: tags: - timeseries summary: Hypnogram operationId: get_hypnogram_grouped deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHypnogramResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: hypnogram_grouped x-fern-availability: deprecated /v2/timeseries/{user_id}/hrv/grouped: get: tags: - timeseries summary: Heart Rate Variability operationId: get_hrv_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHRVResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: hrv_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/heartrate/grouped: get: tags: - timeseries summary: Heart Rate operationId: get_heartrate_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedHeartRateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: heartrate_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/glucose/grouped: get: tags: - timeseries summary: Glucose operationId: get_glucose_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedGlucoseResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: glucose_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/cholesterol/grouped: get: tags: - timeseries summary: Cholesterol operationId: get_cholesterol_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedCholesterolResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/carbohydrates/grouped: get: tags: - timeseries summary: Carbohydrates operationId: get_carbohydrates_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedCarbohydratesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: carbohydrates_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/body_temperature_delta/grouped: get: tags: - timeseries summary: Body Temperature Delta operationId: get_body_temperature_delta_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBodyTemperatureDeltaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_temperature_delta_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/body_temperature/grouped: get: tags: - timeseries summary: Body Temperature operationId: get_body_temperature_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBodyTemperatureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_temperature_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/body_weight/grouped: get: tags: - timeseries summary: Body Weight operationId: get_body_weight_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBodyWeightResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_weight_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/body_fat/grouped: get: tags: - timeseries summary: Body Fat operationId: get_body_fat_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBodyFatResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_fat_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/blood_oxygen/grouped: get: tags: - timeseries summary: Blood Oxygen operationId: get_blood_oxygen_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBloodOxygenResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: blood_oxygen_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/electrocardiogram_voltage/grouped: get: tags: - timeseries summary: Electrocardiogram Voltage operationId: get_electrocardiogram_voltage_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedElectrocardiogramVoltageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: electrocardiogram_voltage_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/blood_pressure/grouped: get: tags: - timeseries summary: Blood Pressure operationId: get_blood_pressure_grouped parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true title: Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. deprecated: true - name: next_cursor in: query required: false schema: anyOf: - type: string - type: 'null' description: The cursor for fetching the next page, or `null` to fetch the first page. title: Next Cursor description: The cursor for fetching the next page, or `null` to fetch the first page. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/GroupedBloodPressureResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: blood_pressure_grouped x-fern-availability: generally-available /v2/timeseries/{user_id}/vo2_max: get: tags: - timeseries summary: Vo2 Max operationId: get_vo2_max deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingVO2MaxTimeseries' title: Response Get Vo2 Max '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: vo2_max x-fern-availability: deprecated /v2/timeseries/{user_id}/stress_level: get: tags: - timeseries summary: Stress Level operationId: get_stress_level deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingStressLevelTimeseries' title: Response Get Stress Level '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: stress_level x-fern-availability: deprecated /v2/timeseries/{user_id}/mindfulness_minutes: get: tags: - timeseries summary: Mindfulness Minutes operationId: get_mindfulness_minutes deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesTimeseries' title: Response Get Mindfulness Minutes '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: mindfulness_minutes x-fern-availability: deprecated /v2/timeseries/{user_id}/caffeine: get: tags: - timeseries summary: Caffeine operationId: get_caffeine deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCaffeineTimeseries' title: Response Get Caffeine '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: caffeine x-fern-availability: deprecated /v2/timeseries/{user_id}/water: get: tags: - timeseries summary: Water operationId: get_water deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingWaterTimeseries' title: Response Get Water '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: water x-fern-availability: deprecated /v2/timeseries/{user_id}/steps: get: tags: - timeseries summary: Steps operationId: get_steps deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingStepsTimeseries' title: Response Get Steps '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: steps x-fern-availability: deprecated /v2/timeseries/{user_id}/floors_climbed: get: tags: - timeseries summary: Floors Climbed operationId: get_floors_climbed deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingFloorsClimbedTimeseries' title: Response Get Floors Climbed '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: floors_climbed x-fern-availability: deprecated /v2/timeseries/{user_id}/distance: get: tags: - timeseries summary: Distance operationId: get_distance deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingDistanceTimeseries' title: Response Get Distance '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: distance x-fern-availability: deprecated /v2/timeseries/{user_id}/calories_basal: get: tags: - timeseries summary: Calories Basal operationId: get_calories_basal deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCaloriesBasalTimeseries' title: Response Get Calories Basal '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: calories_basal x-fern-availability: deprecated /v2/timeseries/{user_id}/calories_active: get: tags: - timeseries summary: Calories Active operationId: get_calories_active deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCaloriesActiveTimeseries' title: Response Get Calories Active '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: calories_active x-fern-availability: deprecated /v2/timeseries/{user_id}/respiratory_rate: get: tags: - timeseries summary: Respiratory Rate operationId: get_respiratory_rate deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingRespiratoryRateTimeseries' title: Response Get Respiratory Rate '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: respiratory_rate x-fern-availability: deprecated /v2/timeseries/{user_id}/ige: get: tags: - timeseries summary: Ige operationId: get_ige deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingIgeTimeseries' title: Response Get Ige '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: ige x-fern-availability: deprecated /v2/timeseries/{user_id}/igg: get: tags: - timeseries summary: Igg operationId: get_igg deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingIggTimeseries' title: Response Get Igg '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: igg x-fern-availability: deprecated /v2/timeseries/{user_id}/hypnogram: get: tags: - timeseries summary: Hypnogram operationId: get_hypnogram deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingHypnogramTimeseries' title: Response Get Hypnogram '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: hypnogram x-fern-availability: deprecated /v2/timeseries/{user_id}/hrv: get: tags: - timeseries summary: Heart Rate Variability operationId: get_hrv deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingHRVTimeseries' title: Response Get Hrv '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: hrv x-fern-availability: deprecated /v2/timeseries/{user_id}/heartrate: get: tags: - timeseries summary: Heart Rate operationId: get_heartrate deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingHeartRateTimeseries' title: Response Get Heartrate '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: heartrate x-fern-availability: deprecated /v2/timeseries/{user_id}/glucose: get: tags: - timeseries summary: Glucose operationId: get_glucose deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingGlucoseTimeseries' title: Response Get Glucose '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: glucose x-fern-availability: deprecated /v2/timeseries/{user_id}/cholesterol/triglycerides: get: tags: - timeseries summary: Cholesterol/Triglycerides operationId: get_cholesterol/triglycerides deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' title: Response Get Cholesterol/Triglycerides '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol/triglycerides x-fern-availability: deprecated /v2/timeseries/{user_id}/cholesterol/total: get: tags: - timeseries summary: Cholesterol/Total operationId: get_cholesterol/total deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' title: Response Get Cholesterol/Total '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol/total x-fern-availability: deprecated /v2/timeseries/{user_id}/cholesterol/ldl: get: tags: - timeseries summary: Cholesterol/Ldl operationId: get_cholesterol/ldl deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' title: Response Get Cholesterol/Ldl '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol/ldl x-fern-availability: deprecated /v2/timeseries/{user_id}/cholesterol/hdl: get: tags: - timeseries summary: Cholesterol/Hdl operationId: get_cholesterol/hdl deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' title: Response Get Cholesterol/Hdl '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol/hdl x-fern-availability: deprecated /v2/timeseries/{user_id}/cholesterol: get: tags: - timeseries summary: Cholesterol operationId: get_cholesterol deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' title: Response Get Cholesterol '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: cholesterol x-fern-availability: deprecated /v2/timeseries/{user_id}/body_weight: get: tags: - timeseries summary: Body Weight operationId: get_body_weight deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingBodyWeightTimeseries' title: Response Get Body Weight '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_weight x-fern-availability: deprecated /v2/timeseries/{user_id}/body_fat: get: tags: - timeseries summary: Body Fat operationId: get_body_fat deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingBodyFatTimeseries' title: Response Get Body Fat '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: body_fat x-fern-availability: deprecated /v2/timeseries/{user_id}/blood_oxygen: get: tags: - timeseries summary: Blood Oxygen operationId: get_blood_oxygen deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingBloodOxygenTimeseries' title: Response Get Blood Oxygen '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: blood_oxygen x-fern-availability: deprecated /v2/timeseries/{user_id}/electrocardiogram_voltage: get: tags: - timeseries summary: Electrocardiogram Voltage operationId: get_electrocardiogram_voltage deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageTimeseries' title: Response Get Electrocardiogram Voltage '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: electrocardiogram_voltage x-fern-availability: deprecated /v2/timeseries/{user_id}/blood_pressure: get: tags: - timeseries summary: Blood Pressure operationId: get_blood_pressure deprecated: true parameters: - name: user_id in: path required: true schema: type: string format: uuid title: User id returned by vital create user id request. This id should be stored in your database against the user and used for all interactions with the vital api. - name: provider in: query required: false schema: type: string description: Provider oura/strava etc default: '' title: Provider description: Provider oura/strava etc - name: start_date in: query required: true schema: type: string description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 title: Start Date description: Date from in YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 00:00:00 - name: end_date in: query required: false schema: anyOf: - type: string - type: 'null' description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 title: End Date description: Date to YYYY-MM-DD or ISO formatted date time. If a date is provided without a time, the time will be set to 23:59:59 responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientFacingBloodPressureTimeseries' title: Response Get Blood Pressure '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-fern-sdk-group-name: vitals x-fern-sdk-method-name: blood_pressure x-fern-availability: deprecated components: schemas: GroupedDaylightExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDaylightExposureSample' type: array type: object required: - source - data title: GroupedDaylightExposure 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 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 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 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 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 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 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 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 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 GroupedStandDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandDurationSample' type: array type: object required: - source - data title: GroupedStandDuration 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 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 GroupedRespiratoryRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingRespiratoryRateTimeseries' type: array type: object required: - source - data title: GroupedRespiratoryRate GroupedUVExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingUVExposureSample' type: array type: object required: - source - data title: GroupedUVExposure 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 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 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 GroupedElectrocardiogramVoltage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageTimeseries' type: array type: object required: - source - data title: GroupedElectrocardiogramVoltage 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 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 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 GroupedWorkoutSwimmingStroke: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeSample' type: array type: object required: - source - data title: GroupedWorkoutSwimmingStroke 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 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 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 GroupedWaistCircumference: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaistCircumferenceSample' type: array type: object required: - source - data title: GroupedWaistCircumference 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 GroupedHRV: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHRVTimeseries' type: array type: object required: - source - data title: GroupedHRV GroupedBodyTemperatureDelta: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaSample' type: array type: object required: - source - data title: GroupedBodyTemperatureDelta GroupedDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDistanceTimeseries' type: array type: object required: - source - data title: GroupedDistance 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 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 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 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 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 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 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 GroupedForcedVitalCapacity: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedVitalCapacitySample' type: array type: object required: - source - data title: GroupedForcedVitalCapacity 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 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 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 _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 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 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 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 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 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 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 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 GroupedWater: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaterTimeseries' type: array type: object required: - source - data title: GroupedWater GroupedStressLevel: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStressLevelTimeseries' type: array type: object required: - source - data title: GroupedStressLevel 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 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 GroupedBloodPressure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodPressureTimeseries' type: array type: object required: - source - data title: GroupedBloodPressure 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 GroupedFall: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFallSample' type: array type: object required: - source - data title: GroupedFall GroupedIge: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIgeTimeseries' type: array type: object required: - source - data title: GroupedIge 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 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 HTTPValidationError: properties: detail: title: Detail type: object title: HTTPValidationError GroupedSleepBreathingDisturbance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceSample' type: array type: object required: - source - data title: GroupedSleepBreathingDisturbance 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 GroupedSleepApneaAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepApneaAlertSample' type: array type: object required: - source - data title: GroupedSleepApneaAlert GroupedCaloriesActive: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesActiveTimeseries' type: array type: object required: - source - data title: GroupedCaloriesActive GroupedBodyWeight: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyWeightTimeseries' type: array type: object required: - source - data title: GroupedBodyWeight 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 GroupedGlucose: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingGlucoseTimeseries' type: array type: object required: - source - data title: GroupedGlucose 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 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 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 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 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 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 GroupedFloorsClimbed: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFloorsClimbedTimeseries' type: array type: object required: - source - data title: GroupedFloorsClimbed 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 GroupedPeakExpiratoryFlowRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateSample' type: array type: object required: - source - data title: GroupedPeakExpiratoryFlowRate 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 GroupedCaffeine: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaffeineTimeseries' type: array type: object required: - source - data title: GroupedCaffeine 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 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 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 GroupedVO2Max: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingVO2MaxTimeseries' type: array type: object required: - source - data title: GroupedVO2Max 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 GroupedBloodOxygen: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodOxygenTimeseries' type: array type: object required: - source - data title: GroupedBloodOxygen 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 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 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 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 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 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 GroupedCarbohydrates: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCarbohydratesSample' type: array type: object required: - source - data title: GroupedCarbohydrates 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 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 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 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 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 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 GroupedForcedExpiratoryVolume1: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1Sample' type: array type: object required: - source - data title: GroupedForcedExpiratoryVolume1 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 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 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 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 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 GroupedHypnogram: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHypnogramTimeseries' type: array type: object required: - source - data title: GroupedHypnogram GroupedBodyMassIndex: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyMassIndexSample' type: array type: object required: - source - data title: GroupedBodyMassIndex GroupedHeartRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateTimeseries' type: array type: object required: - source - data title: GroupedHeartRate GroupedInsulinInjection: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInsulinInjectionSample' type: array type: object required: - source - data title: GroupedInsulinInjection GroupedNote: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingNoteSample' type: array type: object required: - source - data title: GroupedNote GroupedStandHour: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandHourSample' type: array type: object required: - source - data title: GroupedStandHour 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 GroupedHeartRateAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateAlertSample' type: array type: object required: - source - data title: GroupedHeartRateAlert GroupedCholesterol: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' type: array type: object required: - source - data title: GroupedCholesterol GroupedWorkoutDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDistanceSample' type: array type: object required: - source - data title: GroupedWorkoutDistance 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 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 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 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 GroupedInhalerUsage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInhalerUsageSample' type: array type: object required: - source - data title: GroupedInhalerUsage 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 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 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 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 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 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 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 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 GroupedWheelchairPush: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWheelchairPushSample' type: array type: object required: - source - data title: GroupedWheelchairPush 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 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 GroupedHandwashing: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHandwashingSample' type: array type: object required: - source - data title: GroupedHandwashing 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 GroupedIgg: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIggTimeseries' type: array type: object required: - source - data title: GroupedIgg GroupedLeanBodyMass: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingLeanBodyMassSample' type: array type: object required: - source - data title: GroupedLeanBodyMass GroupedCaloriesBasal: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesBasalTimeseries' type: array type: object required: - source - data title: GroupedCaloriesBasal GroupedSteps: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStepsTimeseries' type: array type: object required: - source - data title: GroupedSteps GroupedBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBodyTemperature 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 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 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 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 GroupedAFibBurden: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingAFibBurdenSample' type: array type: object required: - source - data title: GroupedAFibBurden 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 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 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 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 GroupedBodyFat: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyFatTimeseries' type: array type: object required: - source - data title: GroupedBodyFat GroupedHeartRateRecoveryOneMinute: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteSample' type: array type: object required: - source - data title: GroupedHeartRateRecoveryOneMinute GroupedWorkoutDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDurationSample' type: array type: object required: - source - data title: GroupedWorkoutDuration GroupedBasalBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBasalBodyTemperature 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 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 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 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 GroupedMindfulnessMinutes: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesTimeseries' type: array type: object required: - source - data title: GroupedMindfulnessMinutes 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 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 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 securitySchemes: apiKeyAuth: type: apiKey in: header name: x-vital-api-key description: Vital Team API Key