openapi: 3.2.0 info: title: Junction Timeseries API description: https://docs.junction.com/ version: 0.4.497 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: Time Series paths: /v2/timeseries/sleep/{sleep_id}/stream: get: tags: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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: - Time Series 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 webhooks: daily.data.calories_active.*: post: tags: - Time Series summary: Calories Active operationId: calories_activedaily_data_calories_active___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesActiveChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.calories_active.created: post: tags: - Time Series summary: Calories Active Historical Pull Completed operationId: calories_active_historical_pull_completedhistorical_data_calories_active_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesActiveHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.calories_basal.*: post: tags: - Time Series summary: Calories Basal operationId: calories_basaldaily_data_calories_basal___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesBasalChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.calories_basal.created: post: tags: - Time Series summary: Calories Basal Historical Pull Completed operationId: calories_basal_historical_pull_completedhistorical_data_calories_basal_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaloriesBasalHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.blood_pressure.*: post: tags: - Time Series summary: Blood Pressure operationId: blood_pressuredaily_data_blood_pressure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodPressureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.blood_pressure.created: post: tags: - Time Series summary: Blood Pressure Historical Pull Completed operationId: blood_pressure_historical_pull_completedhistorical_data_blood_pressure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodPressureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.blood_oxygen.*: post: tags: - Time Series summary: Blood Oxygen operationId: blood_oxygendaily_data_blood_oxygen___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodOxygenChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.blood_oxygen.created: post: tags: - Time Series summary: Blood Oxygen Historical Pull Completed operationId: blood_oxygen_historical_pull_completedhistorical_data_blood_oxygen_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBloodOxygenHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.weight.*: post: tags: - Time Series summary: Weight operationId: weightdaily_data_weight___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWeightChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.weight.created: post: tags: - Time Series summary: Weight Historical Pull Completed operationId: weight_historical_pull_completedhistorical_data_weight_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWeightHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.fat.*: post: tags: - Time Series summary: Fat operationId: fatdaily_data_fat___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFatChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.fat.created: post: tags: - Time Series summary: Fat Historical Pull Completed operationId: fat_historical_pull_completedhistorical_data_fat_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFatHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_temperature.*: post: tags: - Time Series summary: Body Temperature operationId: body_temperaturedaily_data_body_temperature___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_temperature.created: post: tags: - Time Series summary: Body Temperature Historical Pull Completed operationId: body_temperature_historical_pull_completedhistorical_data_body_temperature_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_temperature_delta.*: post: tags: - Time Series summary: Body Temperature Delta operationId: body_temperature_deltadaily_data_body_temperature_delta___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_temperature_delta.created: post: tags: - Time Series summary: Body Temperature Delta Historical Pull Completed operationId: body_temperature_delta_historical_pull_completedhistorical_data_body_temperature_delta_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.caffeine.*: post: tags: - Time Series summary: Caffeine operationId: caffeinedaily_data_caffeine___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaffeineChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.caffeine.created: post: tags: - Time Series summary: Caffeine Historical Pull Completed operationId: caffeine_historical_pull_completedhistorical_data_caffeine_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCaffeineHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.cholesterol.*: post: tags: - Time Series summary: Cholesterol operationId: cholesteroldaily_data_cholesterol___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCholesterolChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.cholesterol.created: post: tags: - Time Series summary: Cholesterol Historical Pull Completed operationId: cholesterol_historical_pull_completedhistorical_data_cholesterol_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCholesterolHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.distance.*: post: tags: - Time Series summary: Distance operationId: distancedaily_data_distance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDistanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.distance.created: post: tags: - Time Series summary: Distance Historical Pull Completed operationId: distance_historical_pull_completedhistorical_data_distance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDistanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.floors_climbed.*: post: tags: - Time Series summary: Floors Climbed operationId: floors_climbeddaily_data_floors_climbed___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFloorsClimbedChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.floors_climbed.created: post: tags: - Time Series summary: Floors Climbed Historical Pull Completed operationId: floors_climbed_historical_pull_completedhistorical_data_floors_climbed_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFloorsClimbedHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.glucose.*: post: tags: - Time Series summary: Glucose operationId: glucosedaily_data_glucose___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingGlucoseChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.glucose.created: post: tags: - Time Series summary: Glucose Historical Pull Completed operationId: glucose_historical_pull_completedhistorical_data_glucose_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingGlucoseHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heartrate.*: post: tags: - Time Series summary: Heartrate operationId: heartratedaily_data_heartrate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartrateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heartrate.created: post: tags: - Time Series summary: Heartrate Historical Pull Completed operationId: heartrate_historical_pull_completedhistorical_data_heartrate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartrateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.hrv.*: post: tags: - Time Series summary: Hrv operationId: hrvdaily_data_hrv___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHrvChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.hrv.created: post: tags: - Time Series summary: Hrv Historical Pull Completed operationId: hrv_historical_pull_completedhistorical_data_hrv_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHrvHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.ige.*: post: tags: - Time Series summary: Ige operationId: igedaily_data_ige___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIgeChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.ige.created: post: tags: - Time Series summary: Ige Historical Pull Completed operationId: ige_historical_pull_completedhistorical_data_ige_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIgeHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.igg.*: post: tags: - Time Series summary: Igg operationId: iggdaily_data_igg___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIggChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.igg.created: post: tags: - Time Series summary: Igg Historical Pull Completed operationId: igg_historical_pull_completedhistorical_data_igg_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingIggHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.mindfulness_minutes.*: post: tags: - Time Series summary: Mindfulness Minutes operationId: mindfulness_minutesdaily_data_mindfulness_minutes___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.mindfulness_minutes.created: post: tags: - Time Series summary: Mindfulness Minutes Historical Pull Completed operationId: mindfulness_minutes_historical_pull_completedhistorical_data_mindfulness_minutes_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.respiratory_rate.*: post: tags: - Time Series summary: Respiratory Rate operationId: respiratory_ratedaily_data_respiratory_rate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingRespiratoryRateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.respiratory_rate.created: post: tags: - Time Series summary: Respiratory Rate Historical Pull Completed operationId: respiratory_rate_historical_pull_completedhistorical_data_respiratory_rate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingRespiratoryRateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.steps.*: post: tags: - Time Series summary: Steps operationId: stepsdaily_data_steps___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStepsChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.steps.created: post: tags: - Time Series summary: Steps Historical Pull Completed operationId: steps_historical_pull_completedhistorical_data_steps_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStepsHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stress_level.*: post: tags: - Time Series summary: Stress Level operationId: stress_leveldaily_data_stress_level___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStressLevelChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stress_level.created: post: tags: - Time Series summary: Stress Level Historical Pull Completed operationId: stress_level_historical_pull_completedhistorical_data_stress_level_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStressLevelHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.vo2_max.*: post: tags: - Time Series summary: Vo2 Max operationId: vo2_maxdaily_data_vo2_max___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingVo2MaxChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.vo2_max.created: post: tags: - Time Series summary: Vo2 Max Historical Pull Completed operationId: vo2_max_historical_pull_completedhistorical_data_vo2_max_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingVo2MaxHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.water.*: post: tags: - Time Series summary: Water operationId: waterdaily_data_water___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaterChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.water.created: post: tags: - Time Series summary: Water Historical Pull Completed operationId: water_historical_pull_completedhistorical_data_water_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaterHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.electrocardiogram_voltage.*: post: tags: - Time Series summary: Electrocardiogram Voltage operationId: electrocardiogram_voltagedaily_data_electrocardiogram_voltage___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.electrocardiogram_voltage.created: post: tags: - Time Series summary: Electrocardiogram Voltage Historical Pull Completed operationId: electrocardiogram_voltage_historical_pull_completedhistorical_data_electrocardiogram_voltage_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.afib_burden.*: post: tags: - Time Series summary: Afib Burden operationId: afib_burdendaily_data_afib_burden___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingAfibBurdenChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.afib_burden.created: post: tags: - Time Series summary: Afib Burden Historical Pull Completed operationId: afib_burden_historical_pull_completedhistorical_data_afib_burden_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingAfibBurdenHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heart_rate_alert.*: post: tags: - Time Series summary: Heart Rate Alert operationId: heart_rate_alertdaily_data_heart_rate_alert___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateAlertChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heart_rate_alert.created: post: tags: - Time Series summary: Heart Rate Alert Historical Pull Completed operationId: heart_rate_alert_historical_pull_completedhistorical_data_heart_rate_alert_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateAlertHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_duration.*: post: tags: - Time Series summary: Workout Duration operationId: workout_durationdaily_data_workout_duration___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDurationChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_duration.created: post: tags: - Time Series summary: Workout Duration Historical Pull Completed operationId: workout_duration_historical_pull_completedhistorical_data_workout_duration_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDurationHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.insulin_injection.*: post: tags: - Time Series summary: Insulin Injection operationId: insulin_injectiondaily_data_insulin_injection___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInsulinInjectionChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.insulin_injection.created: post: tags: - Time Series summary: Insulin Injection Historical Pull Completed operationId: insulin_injection_historical_pull_completedhistorical_data_insulin_injection_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInsulinInjectionHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.carbohydrates.*: post: tags: - Time Series summary: Carbohydrates operationId: carbohydratesdaily_data_carbohydrates___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCarbohydratesChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.carbohydrates.created: post: tags: - Time Series summary: Carbohydrates Historical Pull Completed operationId: carbohydrates_historical_pull_completedhistorical_data_carbohydrates_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingCarbohydratesHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.note.*: post: tags: - Time Series summary: Note operationId: notedaily_data_note___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingNoteChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.note.created: post: tags: - Time Series summary: Note Historical Pull Completed operationId: note_historical_pull_completedhistorical_data_note_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingNoteHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stand_hour.*: post: tags: - Time Series summary: Stand Hour operationId: stand_hourdaily_data_stand_hour___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandHourChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stand_hour.created: post: tags: - Time Series summary: Stand Hour Historical Pull Completed operationId: stand_hour_historical_pull_completedhistorical_data_stand_hour_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandHourHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.stand_duration.*: post: tags: - Time Series summary: Stand Duration operationId: stand_durationdaily_data_stand_duration___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandDurationChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.stand_duration.created: post: tags: - Time Series summary: Stand Duration Historical Pull Completed operationId: stand_duration_historical_pull_completedhistorical_data_stand_duration_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingStandDurationHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep_apnea_alert.*: post: tags: - Time Series summary: Sleep Apnea Alert operationId: sleep_apnea_alertdaily_data_sleep_apnea_alert___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepApneaAlertChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep_apnea_alert.created: post: tags: - Time Series summary: Sleep Apnea Alert Historical Pull Completed operationId: sleep_apnea_alert_historical_pull_completedhistorical_data_sleep_apnea_alert_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepApneaAlertHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.sleep_breathing_disturbance.*: post: tags: - Time Series summary: Sleep Breathing Disturbance operationId: sleep_breathing_disturbancedaily_data_sleep_breathing_disturbance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.sleep_breathing_disturbance.created: post: tags: - Time Series summary: Sleep Breathing Disturbance Historical Pull Completed operationId: sleep_breathing_disturbance_historical_pull_completedhistorical_data_sleep_breathing_disturbance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.wheelchair_push.*: post: tags: - Time Series summary: Wheelchair Push operationId: wheelchair_pushdaily_data_wheelchair_push___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWheelchairPushChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.wheelchair_push.created: post: tags: - Time Series summary: Wheelchair Push Historical Pull Completed operationId: wheelchair_push_historical_pull_completedhistorical_data_wheelchair_push_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWheelchairPushHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.forced_expiratory_volume_1.*: post: tags: - Time Series summary: Forced Expiratory Volume 1 operationId: forced_expiratory_volume_1daily_data_forced_expiratory_volume_1___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1Changed' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.forced_expiratory_volume_1.created: post: tags: - Time Series summary: Forced Expiratory Volume 1 Historical Pull Completed operationId: forced_expiratory_volume_1_historical_pull_completedhistorical_data_forced_expiratory_volume_1_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.forced_vital_capacity.*: post: tags: - Time Series summary: Forced Vital Capacity operationId: forced_vital_capacitydaily_data_forced_vital_capacity___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedVitalCapacityChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.forced_vital_capacity.created: post: tags: - Time Series summary: Forced Vital Capacity Historical Pull Completed operationId: forced_vital_capacity_historical_pull_completedhistorical_data_forced_vital_capacity_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingForcedVitalCapacityHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.peak_expiratory_flow_rate.*: post: tags: - Time Series summary: Peak Expiratory Flow Rate operationId: peak_expiratory_flow_ratedaily_data_peak_expiratory_flow_rate___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.peak_expiratory_flow_rate.created: post: tags: - Time Series summary: Peak Expiratory Flow Rate Historical Pull Completed operationId: peak_expiratory_flow_rate_historical_pull_completedhistorical_data_peak_expiratory_flow_rate_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.inhaler_usage.*: post: tags: - Time Series summary: Inhaler Usage operationId: inhaler_usagedaily_data_inhaler_usage___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInhalerUsageChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.inhaler_usage.created: post: tags: - Time Series summary: Inhaler Usage Historical Pull Completed operationId: inhaler_usage_historical_pull_completedhistorical_data_inhaler_usage_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingInhalerUsageHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.fall.*: post: tags: - Time Series summary: Fall operationId: falldaily_data_fall___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFallChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.fall.created: post: tags: - Time Series summary: Fall Historical Pull Completed operationId: fall_historical_pull_completedhistorical_data_fall_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingFallHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.uv_exposure.*: post: tags: - Time Series summary: Uv Exposure operationId: uv_exposuredaily_data_uv_exposure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingUvExposureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.uv_exposure.created: post: tags: - Time Series summary: Uv Exposure Historical Pull Completed operationId: uv_exposure_historical_pull_completedhistorical_data_uv_exposure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingUvExposureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.daylight_exposure.*: post: tags: - Time Series summary: Daylight Exposure operationId: daylight_exposuredaily_data_daylight_exposure___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDaylightExposureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.daylight_exposure.created: post: tags: - Time Series summary: Daylight Exposure Historical Pull Completed operationId: daylight_exposure_historical_pull_completedhistorical_data_daylight_exposure_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingDaylightExposureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.handwashing.*: post: tags: - Time Series summary: Handwashing operationId: handwashingdaily_data_handwashing___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHandwashingChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.handwashing.created: post: tags: - Time Series summary: Handwashing Historical Pull Completed operationId: handwashing_historical_pull_completedhistorical_data_handwashing_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHandwashingHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.basal_body_temperature.*: post: tags: - Time Series summary: Basal Body Temperature operationId: basal_body_temperaturedaily_data_basal_body_temperature___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.basal_body_temperature.created: post: tags: - Time Series summary: Basal Body Temperature Historical Pull Completed operationId: basal_body_temperature_historical_pull_completedhistorical_data_basal_body_temperature_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.body_mass_index.*: post: tags: - Time Series summary: Body Mass Index operationId: body_mass_indexdaily_data_body_mass_index___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyMassIndexChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.body_mass_index.created: post: tags: - Time Series summary: Body Mass Index Historical Pull Completed operationId: body_mass_index_historical_pull_completedhistorical_data_body_mass_index_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingBodyMassIndexHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.lean_body_mass.*: post: tags: - Time Series summary: Lean Body Mass operationId: lean_body_massdaily_data_lean_body_mass___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLeanBodyMassChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.lean_body_mass.created: post: tags: - Time Series summary: Lean Body Mass Historical Pull Completed operationId: lean_body_mass_historical_pull_completedhistorical_data_lean_body_mass_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingLeanBodyMassHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.waist_circumference.*: post: tags: - Time Series summary: Waist Circumference operationId: waist_circumferencedaily_data_waist_circumference___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaistCircumferenceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.waist_circumference.created: post: tags: - Time Series summary: Waist Circumference Historical Pull Completed operationId: waist_circumference_historical_pull_completedhistorical_data_waist_circumference_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWaistCircumferenceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.heart_rate_recovery_one_minute.*: post: tags: - Time Series summary: Heart Rate Recovery One Minute operationId: heart_rate_recovery_one_minutedaily_data_heart_rate_recovery_one_minute___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.heart_rate_recovery_one_minute.created: post: tags: - Time Series summary: Heart Rate Recovery One Minute Historical Pull Completed operationId: heart_rate_recovery_one_minute_historical_pull_completedhistorical_data_heart_rate_recovery_one_minute_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_distance.*: post: tags: - Time Series summary: Workout Distance operationId: workout_distancedaily_data_workout_distance___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDistanceChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_distance.created: post: tags: - Time Series summary: Workout Distance Historical Pull Completed operationId: workout_distance_historical_pull_completedhistorical_data_workout_distance_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutDistanceHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' daily.data.workout_swimming_stroke.*: post: tags: - Time Series summary: Workout Swimming Stroke operationId: workout_swimming_strokedaily_data_workout_swimming_stroke___post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeChanged' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' historical.data.workout_swimming_stroke.created: post: tags: - Time Series summary: Workout Swimming Stroke Historical Pull Completed operationId: workout_swimming_stroke_historical_pull_completedhistorical_data_workout_swimming_stroke_created_post requestBody: content: application/json: schema: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: 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 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 GroupedPeakExpiratoryFlowRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingPeakExpiratoryFlowRateSample' type: array type: object required: - source - data title: GroupedPeakExpiratoryFlowRate 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 ClientFacingGlucoseHistoricalPullCompleted: properties: event_type: type: string const: historical.data.glucose.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingGlucoseHistoricalPullCompleted 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 ClientFacingWheelchairPushChanged: properties: event_type: type: string enum: - daily.data.wheelchair_push.created - daily.data.wheelchair_push.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWheelchairPush' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWheelchairPushChanged ClientFacingWeightChanged: properties: event_type: type: string enum: - daily.data.weight.created - daily.data.weight.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyWeight' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWeightChanged 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 _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 GroupedCaloriesBasal: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesBasalTimeseries' type: array type: object required: - source - data title: GroupedCaloriesBasal ClientFacingCaloriesBasalChanged: properties: event_type: type: string enum: - daily.data.calories_basal.created - daily.data.calories_basal.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaloriesBasal' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesBasalChanged ClientFacingBodyTemperatureDeltaHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_temperature_delta.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureDeltaHistoricalPullCompleted GroupedSleepApneaAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepApneaAlertSample' type: array type: object required: - source - data title: GroupedSleepApneaAlert 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 GroupedBloodPressure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodPressureTimeseries' type: array type: object required: - source - data title: GroupedBloodPressure GroupedHRV: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHRVTimeseries' type: array type: object required: - source - data title: GroupedHRV 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 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 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 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 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 GroupedStandDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandDurationSample' type: array type: object required: - source - data title: GroupedStandDuration 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 ClientFacingCaffeineHistoricalPullCompleted: properties: event_type: type: string const: historical.data.caffeine.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaffeineHistoricalPullCompleted ClientFacingCarbohydratesChanged: properties: event_type: type: string enum: - daily.data.carbohydrates.created - daily.data.carbohydrates.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCarbohydrates' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCarbohydratesChanged 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 ClientFacingNoteChanged: properties: event_type: type: string enum: - daily.data.note.created - daily.data.note.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedNote' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingNoteChanged GroupedFall: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFallSample' type: array type: object required: - source - data title: GroupedFall 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 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 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 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 ClientFacingWaistCircumferenceChanged: properties: event_type: type: string enum: - daily.data.waist_circumference.created - daily.data.waist_circumference.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWaistCircumference' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaistCircumferenceChanged 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 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 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 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 ClientFacingFallHistoricalPullCompleted: properties: event_type: type: string const: historical.data.fall.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFallHistoricalPullCompleted ClientFacingUvExposureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.uv_exposure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingUvExposureHistoricalPullCompleted 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 ClientFacingWorkoutDurationHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_duration.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDurationHistoricalPullCompleted GroupedBodyFat: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyFatTimeseries' type: array type: object required: - source - data title: GroupedBodyFat GroupedBloodOxygen: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBloodOxygenTimeseries' type: array type: object required: - source - data title: GroupedBloodOxygen ClientFacingBasalBodyTemperatureChanged: properties: event_type: type: string enum: - daily.data.basal_body_temperature.created - daily.data.basal_body_temperature.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBasalBodyTemperature' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBasalBodyTemperatureChanged 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 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 ClientFacingCarbohydratesHistoricalPullCompleted: properties: event_type: type: string const: historical.data.carbohydrates.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCarbohydratesHistoricalPullCompleted 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 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 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 ClientFacingWorkoutDistanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_distance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDistanceHistoricalPullCompleted ClientFacingPeakExpiratoryFlowRateChanged: properties: event_type: type: string enum: - daily.data.peak_expiratory_flow_rate.created - daily.data.peak_expiratory_flow_rate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedPeakExpiratoryFlowRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingPeakExpiratoryFlowRateChanged 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 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 ClientFacingHrvChanged: properties: event_type: type: string enum: - daily.data.hrv.created - daily.data.hrv.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHRV' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHrvChanged ClientFacingHeartRateAlertChanged: properties: event_type: type: string enum: - daily.data.heart_rate_alert.created - daily.data.heart_rate_alert.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRateAlert' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateAlertChanged GroupedCaffeine: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaffeineTimeseries' type: array type: object required: - source - data title: GroupedCaffeine 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 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 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 ClientFacingHandwashingChanged: properties: event_type: type: string enum: - daily.data.handwashing.created - daily.data.handwashing.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHandwashing' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHandwashingChanged GroupedRespiratoryRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingRespiratoryRateTimeseries' type: array type: object required: - source - data title: GroupedRespiratoryRate ClientFacingHrvHistoricalPullCompleted: properties: event_type: type: string const: historical.data.hrv.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHrvHistoricalPullCompleted ClientFacingHandwashingHistoricalPullCompleted: properties: event_type: type: string const: historical.data.handwashing.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHandwashingHistoricalPullCompleted 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 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 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 ClientFacingBloodPressureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.blood_pressure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodPressureHistoricalPullCompleted GroupedWorkoutSwimmingStroke: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutSwimmingStrokeSample' type: array type: object required: - source - data title: GroupedWorkoutSwimmingStroke ClientFacingAfibBurdenChanged: properties: event_type: type: string enum: - daily.data.afib_burden.created - daily.data.afib_burden.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedAFibBurden' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingAfibBurdenChanged ClientFacingVo2MaxHistoricalPullCompleted: properties: event_type: type: string const: historical.data.vo2_max.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingVo2MaxHistoricalPullCompleted HistoricalPullCompleted: properties: user_id: type: string format: uuid title: User Id start_date: type: string format: date-time title: Start Date end_date: type: string format: date-time title: End Date is_final: type: boolean const: true title: Is Final provider: type: string title: Provider type: object required: - user_id - start_date - end_date - is_final - provider title: HistoricalPullCompleted GroupedSteps: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStepsTimeseries' type: array type: object required: - source - data title: GroupedSteps 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 GroupedForcedVitalCapacity: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedVitalCapacitySample' type: array type: object required: - source - data title: GroupedForcedVitalCapacity ClientFacingHeartRateRecoveryOneMinuteChanged: properties: event_type: type: string enum: - daily.data.heart_rate_recovery_one_minute.created - daily.data.heart_rate_recovery_one_minute.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRateRecoveryOneMinute' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateRecoveryOneMinuteChanged ClientFacingInhalerUsageHistoricalPullCompleted: properties: event_type: type: string const: historical.data.inhaler_usage.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInhalerUsageHistoricalPullCompleted HTTPValidationError: properties: detail: title: Detail type: object title: HTTPValidationError GroupedBodyTemperatureDelta: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureDeltaSample' type: array type: object required: - source - data title: GroupedBodyTemperatureDelta GroupedIgg: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIggTimeseries' type: array type: object required: - source - data title: GroupedIgg GroupedBodyMassIndex: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyMassIndexSample' type: array type: object required: - source - data title: GroupedBodyMassIndex 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 ClientFacingElectrocardiogramVoltageChanged: properties: event_type: type: string enum: - daily.data.electrocardiogram_voltage.created - daily.data.electrocardiogram_voltage.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedElectrocardiogramVoltage' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramVoltageChanged GroupedVO2Max: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingVO2MaxTimeseries' type: array type: object required: - source - data title: GroupedVO2Max ClientFacingVo2MaxChanged: properties: event_type: type: string enum: - daily.data.vo2_max.created - daily.data.vo2_max.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedVO2Max' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingVo2MaxChanged 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 ClientFacingCaloriesActiveHistoricalPullCompleted: properties: event_type: type: string const: historical.data.calories_active.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesActiveHistoricalPullCompleted 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 GroupedBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBodyTemperature 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 GroupedIge: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingIgeTimeseries' type: array type: object required: - source - data title: GroupedIge 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 GroupedWorkoutDuration: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDurationSample' type: array type: object required: - source - data title: GroupedWorkoutDuration GroupedInhalerUsage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInhalerUsageSample' type: array type: object required: - source - data title: GroupedInhalerUsage ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep_breathing_disturbance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepBreathingDisturbanceHistoricalPullCompleted 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 ClientFacingRespiratoryRateChanged: properties: event_type: type: string enum: - daily.data.respiratory_rate.created - daily.data.respiratory_rate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedRespiratoryRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingRespiratoryRateChanged ClientFacingDaylightExposureChanged: properties: event_type: type: string enum: - daily.data.daylight_exposure.created - daily.data.daylight_exposure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedDaylightExposure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDaylightExposureChanged ClientFacingBodyTemperatureChanged: properties: event_type: type: string enum: - daily.data.body_temperature.created - daily.data.body_temperature.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyTemperature' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureChanged GroupedAFibBurden: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingAFibBurdenSample' type: array type: object required: - source - data title: GroupedAFibBurden 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 ClientFacingStandDurationHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stand_duration.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandDurationHistoricalPullCompleted 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 ClientFacingStandDurationChanged: properties: event_type: type: string enum: - daily.data.stand_duration.created - daily.data.stand_duration.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStandDuration' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandDurationChanged 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 ClientFacingNoteHistoricalPullCompleted: properties: event_type: type: string const: historical.data.note.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingNoteHistoricalPullCompleted 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 GroupedFloorsClimbed: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingFloorsClimbedTimeseries' type: array type: object required: - source - data title: GroupedFloorsClimbed ClientFacingForcedExpiratoryVolume1Changed: properties: event_type: type: string enum: - daily.data.forced_expiratory_volume_1.created - daily.data.forced_expiratory_volume_1.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedForcedExpiratoryVolume1' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedExpiratoryVolume1Changed 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 ClientFacingRespiratoryRateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.respiratory_rate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingRespiratoryRateHistoricalPullCompleted ClientFacingCaloriesActiveChanged: properties: event_type: type: string enum: - daily.data.calories_active.created - daily.data.calories_active.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaloriesActive' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesActiveChanged ClientFacingBodyTemperatureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_temperature.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureHistoricalPullCompleted ClientFacingFatHistoricalPullCompleted: properties: event_type: type: string const: historical.data.fat.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFatHistoricalPullCompleted GroupedWheelchairPush: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWheelchairPushSample' type: array type: object required: - source - data title: GroupedWheelchairPush ClientFacingWorkoutDurationChanged: properties: event_type: type: string enum: - daily.data.workout_duration.created - daily.data.workout_duration.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutDuration' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDurationChanged ClientFacingIgeChanged: properties: event_type: type: string enum: - daily.data.ige.created - daily.data.ige.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedIge' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIgeChanged ClientFacingStressLevelChanged: properties: event_type: type: string enum: - daily.data.stress_level.created - daily.data.stress_level.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStressLevel' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStressLevelChanged ClientFacingBodyMassIndexHistoricalPullCompleted: properties: event_type: type: string const: historical.data.body_mass_index.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyMassIndexHistoricalPullCompleted GroupedHeartRateRecoveryOneMinute: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateRecoveryOneMinuteSample' type: array type: object required: - source - data title: GroupedHeartRateRecoveryOneMinute 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 ClientFacingAfibBurdenHistoricalPullCompleted: properties: event_type: type: string const: historical.data.afib_burden.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingAfibBurdenHistoricalPullCompleted ClientFacingSleepBreathingDisturbanceChanged: properties: event_type: type: string enum: - daily.data.sleep_breathing_disturbance.created - daily.data.sleep_breathing_disturbance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSleepBreathingDisturbance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepBreathingDisturbanceChanged ClientFacingBloodOxygenHistoricalPullCompleted: properties: event_type: type: string const: historical.data.blood_oxygen.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodOxygenHistoricalPullCompleted 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 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 ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted: properties: event_type: type: string const: historical.data.forced_expiratory_volume_1.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedExpiratoryVolume1HistoricalPullCompleted GroupedDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDistanceTimeseries' type: array type: object required: - source - data title: GroupedDistance ClientFacingInsulinInjectionHistoricalPullCompleted: properties: event_type: type: string const: historical.data.insulin_injection.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInsulinInjectionHistoricalPullCompleted 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 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 ClientFacingWaistCircumferenceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.waist_circumference.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaistCircumferenceHistoricalPullCompleted ClientFacingElectrocardiogramVoltageHistoricalPullCompleted: properties: event_type: type: string const: historical.data.electrocardiogram_voltage.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingElectrocardiogramVoltageHistoricalPullCompleted GroupedElectrocardiogramVoltage: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingElectrocardiogramVoltageTimeseries' type: array type: object required: - source - data title: GroupedElectrocardiogramVoltage ClientFacingCholesterolHistoricalPullCompleted: properties: event_type: type: string const: historical.data.cholesterol.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCholesterolHistoricalPullCompleted 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 ClientFacingBloodPressureChanged: properties: event_type: type: string enum: - daily.data.blood_pressure.created - daily.data.blood_pressure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBloodPressure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodPressureChanged 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 ClientFacingInhalerUsageChanged: properties: event_type: type: string enum: - daily.data.inhaler_usage.created - daily.data.inhaler_usage.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedInhalerUsage' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInhalerUsageChanged 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 GroupedSleepBreathingDisturbance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingSleepBreathingDisturbanceSample' type: array type: object required: - source - data title: GroupedSleepBreathingDisturbance ClientFacingDistanceChanged: properties: event_type: type: string enum: - daily.data.distance.created - daily.data.distance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedDistance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDistanceChanged ClientFacingStepsChanged: properties: event_type: type: string enum: - daily.data.steps.created - daily.data.steps.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSteps' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStepsChanged 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 ClientFacingWorkoutDistanceChanged: properties: event_type: type: string enum: - daily.data.workout_distance.created - daily.data.workout_distance.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutDistance' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutDistanceChanged ClientFacingStandHourChanged: properties: event_type: type: string enum: - daily.data.stand_hour.created - daily.data.stand_hour.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedStandHour' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandHourChanged ClientFacingHeartrateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heartrate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartrateHistoricalPullCompleted ClientFacingHeartRateAlertHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heart_rate_alert.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateAlertHistoricalPullCompleted 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 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 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 GroupedInsulinInjection: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingInsulinInjectionSample' type: array type: object required: - source - data title: GroupedInsulinInjection 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 ClientFacingIggChanged: properties: event_type: type: string enum: - daily.data.igg.created - daily.data.igg.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedIgg' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIggChanged 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 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 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 ClientFacingStressLevelHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stress_level.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStressLevelHistoricalPullCompleted 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 ClientFacingBodyMassIndexChanged: properties: event_type: type: string enum: - daily.data.body_mass_index.created - daily.data.body_mass_index.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyMassIndex' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyMassIndexChanged GroupedStandHour: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStandHourSample' type: array type: object required: - source - data title: GroupedStandHour 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 ClientFacingFloorsClimbedChanged: properties: event_type: type: string enum: - daily.data.floors_climbed.created - daily.data.floors_climbed.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedFloorsClimbed' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFloorsClimbedChanged GroupedGlucose: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingGlucoseTimeseries' type: array type: object required: - source - data title: GroupedGlucose ClientFacingLeanBodyMassChanged: properties: event_type: type: string enum: - daily.data.lean_body_mass.created - daily.data.lean_body_mass.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedLeanBodyMass' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLeanBodyMassChanged ClientFacingForcedVitalCapacityChanged: properties: event_type: type: string enum: - daily.data.forced_vital_capacity.created - daily.data.forced_vital_capacity.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedForcedVitalCapacity' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedVitalCapacityChanged GroupedStressLevel: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingStressLevelTimeseries' type: array type: object required: - source - data title: GroupedStressLevel ClientFacingCaffeineChanged: properties: event_type: type: string enum: - daily.data.caffeine.created - daily.data.caffeine.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCaffeine' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaffeineChanged 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 GroupedHypnogram: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHypnogramTimeseries' type: array type: object required: - source - data title: GroupedHypnogram ClientFacingWaterChanged: properties: event_type: type: string enum: - daily.data.water.created - daily.data.water.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWater' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaterChanged ClientFacingSleepApneaAlertChanged: properties: event_type: type: string enum: - daily.data.sleep_apnea_alert.created - daily.data.sleep_apnea_alert.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedSleepApneaAlert' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepApneaAlertChanged 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 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 ClientFacingBasalBodyTemperatureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.basal_body_temperature.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBasalBodyTemperatureHistoricalPullCompleted ClientFacingWeightHistoricalPullCompleted: properties: event_type: type: string const: historical.data.weight.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWeightHistoricalPullCompleted ClientFacingCholesterolChanged: properties: event_type: type: string enum: - daily.data.cholesterol.created - daily.data.cholesterol.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedCholesterol' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCholesterolChanged GroupedCaloriesActive: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCaloriesActiveTimeseries' type: array type: object required: - source - data title: GroupedCaloriesActive ClientFacingDistanceHistoricalPullCompleted: properties: event_type: type: string const: historical.data.distance.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDistanceHistoricalPullCompleted 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 GroupedMindfulnessMinutes: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingMindfulnessMinutesTimeseries' type: array type: object required: - source - data title: GroupedMindfulnessMinutes ClientFacingGlucoseChanged: properties: event_type: type: string enum: - daily.data.glucose.created - daily.data.glucose.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedGlucose' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingGlucoseChanged ClientFacingIggHistoricalPullCompleted: properties: event_type: type: string const: historical.data.igg.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIggHistoricalPullCompleted ClientFacingForcedVitalCapacityHistoricalPullCompleted: properties: event_type: type: string const: historical.data.forced_vital_capacity.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingForcedVitalCapacityHistoricalPullCompleted ClientFacingBloodOxygenChanged: properties: event_type: type: string enum: - daily.data.blood_oxygen.created - daily.data.blood_oxygen.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBloodOxygen' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBloodOxygenChanged 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 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 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 GroupedBodyWeight: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBodyWeightTimeseries' type: array type: object required: - source - data title: GroupedBodyWeight 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 GroupedNote: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingNoteSample' type: array type: object required: - source - data title: GroupedNote ClientFacingUvExposureChanged: properties: event_type: type: string enum: - daily.data.uv_exposure.created - daily.data.uv_exposure.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedUVExposure' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingUvExposureChanged 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 ClientFacingWorkoutSwimmingStrokeChanged: properties: event_type: type: string enum: - daily.data.workout_swimming_stroke.created - daily.data.workout_swimming_stroke.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedWorkoutSwimmingStroke' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutSwimmingStrokeChanged ClientFacingDaylightExposureHistoricalPullCompleted: properties: event_type: type: string const: historical.data.daylight_exposure.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingDaylightExposureHistoricalPullCompleted ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted: properties: event_type: type: string const: historical.data.heart_rate_recovery_one_minute.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartRateRecoveryOneMinuteHistoricalPullCompleted 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 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 ClientFacingHeartrateChanged: properties: event_type: type: string enum: - daily.data.heartrate.created - daily.data.heartrate.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedHeartRate' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingHeartrateChanged GroupedHeartRate: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateTimeseries' type: array type: object required: - source - data title: GroupedHeartRate 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 GroupedWaistCircumference: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaistCircumferenceSample' type: array type: object required: - source - data title: GroupedWaistCircumference 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 ClientFacingInsulinInjectionChanged: properties: event_type: type: string enum: - daily.data.insulin_injection.created - daily.data.insulin_injection.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedInsulinInjection' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingInsulinInjectionChanged 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 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 ClientFacingLeanBodyMassHistoricalPullCompleted: properties: event_type: type: string const: historical.data.lean_body_mass.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingLeanBodyMassHistoricalPullCompleted GroupedWorkoutDistance: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWorkoutDistanceSample' type: array type: object required: - source - data title: GroupedWorkoutDistance ClientFacingFloorsClimbedHistoricalPullCompleted: properties: event_type: type: string const: historical.data.floors_climbed.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFloorsClimbedHistoricalPullCompleted 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 ClientFacingCaloriesBasalHistoricalPullCompleted: properties: event_type: type: string const: historical.data.calories_basal.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingCaloriesBasalHistoricalPullCompleted GroupedHeartRateAlert: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHeartRateAlertSample' type: array type: object required: - source - data title: GroupedHeartRateAlert GroupedCarbohydrates: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCarbohydratesSample' type: array type: object required: - source - data title: GroupedCarbohydrates ClientFacingWaterHistoricalPullCompleted: properties: event_type: type: string const: historical.data.water.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWaterHistoricalPullCompleted ClientFacingBodyTemperatureDeltaSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: °C title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. sensor_location: anyOf: - type: string enum: - armpit - body - ear - finger - gastrointestinal - mouth - rectum - toe - eardrum - temporal_artery - forehead - wrist - type: 'null' title: Sensor Location description: Location of the temperature sensor. ℹ️ This enum is non-exhaustive. type: object required: - unit - timestamp - start - end - value - sensor_location title: ClientFacingBodyTemperatureDeltaSample example: end: '2023-02-13T14:57:24+00:00' sensor_location: wrist start: '2023-02-13T14:30:52+00:00' unit: °C value: -1 ClientFacingBodyTemperatureSample: properties: id: anyOf: - type: integer - type: 'null' title: Id description: Deprecated timezone_offset: anyOf: - type: integer - type: 'null' title: Timezone Offset description: Time zone UTC offset in seconds. Positive offset indicates east of UTC; negative offset indicates west of UTC; and null indicates the time zone information is unavailable at source. type: anyOf: - type: string - type: 'null' title: Type description: Type is always null for this resource. unit: type: string const: °C title: Unit timestamp: type: string format: date-time title: Timestamp description: Depracated. The start time (inclusive) of the interval. start: type: string format: date-time title: Start description: The start time (inclusive) of the interval. end: type: string format: date-time title: End description: The end time (exclusive) of the interval. value: type: number title: Value description: The recorded value for the interval. sensor_location: anyOf: - type: string enum: - armpit - body - ear - finger - gastrointestinal - mouth - rectum - toe - eardrum - temporal_artery - forehead - wrist - type: 'null' title: Sensor Location description: Location of the temperature sensor. ℹ️ This enum is non-exhaustive. type: object required: - unit - timestamp - start - end - value - sensor_location title: ClientFacingBodyTemperatureSample example: end: '2023-02-13T14:30:52+00:00' sensor_location: eardrum start: '2023-02-13T14:30:52+00:00' unit: °C value: 65 ClientFacingMindfulnessMinutesChanged: properties: event_type: type: string enum: - daily.data.mindfulness_minutes.created - daily.data.mindfulness_minutes.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedMindfulnessMinutes' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMindfulnessMinutesChanged GroupedLeanBodyMass: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingLeanBodyMassSample' type: array type: object required: - source - data title: GroupedLeanBodyMass ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted: properties: event_type: type: string const: historical.data.peak_expiratory_flow_rate.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingPeakExpiratoryFlowRateHistoricalPullCompleted 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 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 ClientFacingSleepApneaAlertHistoricalPullCompleted: properties: event_type: type: string const: historical.data.sleep_apnea_alert.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingSleepApneaAlertHistoricalPullCompleted ClientFacingIgeHistoricalPullCompleted: properties: event_type: type: string const: historical.data.ige.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingIgeHistoricalPullCompleted 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 GroupedCholesterol: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingCholesterolTimeseries' type: array type: object required: - source - data title: GroupedCholesterol 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 ClientFacingStandHourHistoricalPullCompleted: properties: event_type: type: string const: historical.data.stand_hour.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStandHourHistoricalPullCompleted 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 GroupedWater: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingWaterTimeseries' type: array type: object required: - source - data title: GroupedWater 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 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 GroupedForcedExpiratoryVolume1: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingForcedExpiratoryVolume1Sample' type: array type: object required: - source - data title: GroupedForcedExpiratoryVolume1 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 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 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 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 GroupedBasalBodyTemperature: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingBasalBodyTemperatureSample' type: array type: object required: - source - data title: GroupedBasalBodyTemperature 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 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 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 ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted: properties: event_type: type: string const: historical.data.workout_swimming_stroke.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWorkoutSwimmingStrokeHistoricalPullCompleted ClientFacingFatChanged: properties: event_type: type: string enum: - daily.data.fat.created - daily.data.fat.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyFat' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFatChanged ClientFacingStepsHistoricalPullCompleted: properties: event_type: type: string const: historical.data.steps.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingStepsHistoricalPullCompleted ClientFacingWheelchairPushHistoricalPullCompleted: properties: event_type: type: string const: historical.data.wheelchair_push.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingWheelchairPushHistoricalPullCompleted 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 ClientFacingMindfulnessMinutesHistoricalPullCompleted: properties: event_type: type: string const: historical.data.mindfulness_minutes.created title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/HistoricalPullCompleted' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingMindfulnessMinutesHistoricalPullCompleted 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 ClientFacingBodyTemperatureDeltaChanged: properties: event_type: type: string enum: - daily.data.body_temperature_delta.created - daily.data.body_temperature_delta.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedBodyTemperatureDelta' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingBodyTemperatureDeltaChanged GroupedHandwashing: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingHandwashingSample' type: array type: object required: - source - data title: GroupedHandwashing GroupedDaylightExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingDaylightExposureSample' type: array type: object required: - source - data title: GroupedDaylightExposure GroupedUVExposure: properties: source: $ref: '#/components/schemas/ClientFacingSource' data: items: $ref: '#/components/schemas/ClientFacingUVExposureSample' type: array type: object required: - source - data title: GroupedUVExposure 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 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 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 ClientFacingFallChanged: properties: event_type: type: string enum: - daily.data.fall.created - daily.data.fall.updated title: Event Type x-junction-exhaustive: true user_id: type: string format: uuid title: User Id client_user_id: type: string format: uuid title: Client User Id team_id: type: string format: uuid title: Team Id data: $ref: '#/components/schemas/GroupedFall' type: object required: - event_type - user_id - client_user_id - team_id - data title: ClientFacingFallChanged 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 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 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 securitySchemes: apiKeyAuth: type: apiKey in: header name: x-vital-api-key description: Vital Team API Key