Junction Sense — query and aggregation API for per-user health data. Run on-demand aggregate queries across a user's ingested wearable and lab data, fetch the result table for a defined continuous query, and read continuous-query task-execution history. Sense turns raw ingest into clinically meaningful metrics (sleep debt, HRV trends, glucose variability, etc.) without you owning the aggregation infrastructure.
openapi: 3.1.0
info:
title: Vital Sense API
description: Junction Sense — continuous-query and aggregation API for per-user health data. Run on-demand queries against
a user's ingested wearable and lab data, fetch the result-table for a continuous query, and read the task-execution history.
version: 0.4.497
contact:
name: Junction (Vital) Support
url: https://docs.junction.com
paths:
/aggregate/v1/user/{user_id}/query:
post:
summary: Query One
operationId: query_one_aggregate_v1_user__user_id__query_post
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
title: The user id to query for
- name: accept
in: header
required: false
schema:
enum:
- '*/*'
- application/json
- application/vnd.vital.tar+gzip+parquet
type: string
default: '*/*'
title: Accept
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/QueryBatch'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AggregationResponse'
application/vnd.vital.tar+gzip+parquet: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-fern-sdk-group-name: aggregate
x-fern-sdk-method-name: query_one
x-fern-availability: beta
/aggregate/v1/user/{user_id}/continuous_query/{query_id_or_slug}/result_table:
get:
summary: Get Result Table For Query
operationId: get_result_table_for_query_aggregate_v1_user__user_id__continuous_query__query_id_or_slug__result_table_get
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
title: User Id
- name: query_id_or_slug
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
union_mode: left_to_right
title: Query Id Or Slug
- name: accept
in: header
required: false
schema:
enum:
- '*/*'
- application/json
- application/vnd.apache.parquet
type: string
default: '*/*'
title: Accept
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/AggregationResult'
application/vnd.apache.parquet: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-fern-sdk-group-name: aggregate
x-fern-sdk-method-name: get_result_table_for_continuous_query
x-fern-availability: beta
/aggregate/v1/user/{user_id}/continuous_query/{query_id_or_slug}/task_history:
get:
summary: Get Task History For Query
operationId: get_task_history_for_query_aggregate_v1_user__user_id__continuous_query__query_id_or_slug__task_history_get
parameters:
- name: user_id
in: path
required: true
schema:
type: string
format: uuid
title: User Id
- name: query_id_or_slug
in: path
required: true
schema:
anyOf:
- type: string
format: uuid
- type: string
union_mode: left_to_right
title: Query Id Or Slug
- name: next_cursor
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Next Cursor
- name: limit
in: query
required: false
schema:
type: integer
default: 50
title: Limit
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ContinuousQueryTaskHistoryResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
x-fern-sdk-group-name: aggregate
x-fern-sdk-method-name: get_task_history_for_continuous_query
x-fern-availability: beta
webhooks:
daily.data.activity.*:
post:
tags:
- summary
summary: Activity
operationId: activitydaily_data_activity___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingActivityChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.sleep.*:
post:
tags:
- summary
summary: Sleep
operationId: sleepdaily_data_sleep___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingSleepChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.sleep_cycle.*:
post:
tags:
- summary
summary: Sleep Cycle
operationId: sleep_cycledaily_data_sleep_cycle___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingSleepCycleChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.workouts.*:
post:
tags:
- summary
summary: Workout
operationId: workoutdaily_data_workouts___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWorkoutsChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.workout_stream.*:
post:
tags:
- summary
summary: Workout Stream
operationId: workout_streamdaily_data_workout_stream___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWorkoutStreamChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.body.*:
post:
tags:
- summary
summary: Body
operationId: bodydaily_data_body___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBodyChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.profile.*:
post:
tags:
- summary
summary: Profile
operationId: profiledaily_data_profile___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingProfileChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.meal.*:
post:
tags:
- summary
summary: Meal
operationId: mealdaily_data_meal___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingMealChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.menstrual_cycle.*:
post:
tags:
- summary
summary: Menstrual Cycle
operationId: menstrual_cycledaily_data_menstrual_cycle___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingMenstrualCycleChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.electrocardiogram.*:
post:
tags:
- summary
summary: Electrocardiogram
operationId: electrocardiogramdaily_data_electrocardiogram___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingElectrocardiogramChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.activity.created:
post:
tags:
- summary
summary: Activity Historical Pull Completed
operationId: activity_historical_pull_completedhistorical_data_activity_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingActivityHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.sleep.created:
post:
tags:
- summary
summary: Sleep Historical Pull Completed
operationId: sleep_historical_pull_completedhistorical_data_sleep_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingSleepHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.sleep_cycle.created:
post:
tags:
- summary
summary: Sleep Cycle Historical Pull Completed
operationId: sleep_cycle_historical_pull_completedhistorical_data_sleep_cycle_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingSleepCycleHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.workouts.created:
post:
tags:
- summary
summary: Workout Historical Pull Completed
operationId: workout_historical_pull_completedhistorical_data_workouts_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWorkoutsHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.workout_stream.created:
post:
tags:
- summary
summary: Workout Stream Historical Pull Completed
operationId: workout_stream_historical_pull_completedhistorical_data_workout_stream_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWorkoutStreamHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.body.created:
post:
tags:
- summary
summary: Body Historical Pull Completed
operationId: body_historical_pull_completedhistorical_data_body_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBodyHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.profile.created:
post:
tags:
- summary
summary: Profile Historical Pull Completed
operationId: profile_historical_pull_completedhistorical_data_profile_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingProfileHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.meal.created:
post:
tags:
- summary
summary: Meal Historical Pull Completed
operationId: meal_historical_pull_completedhistorical_data_meal_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingMealHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.menstrual_cycle.created:
post:
tags:
- summary
summary: Menstrual Cycle Historical Pull Completed
operationId: menstrual_cycle_historical_pull_completedhistorical_data_menstrual_cycle_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingMenstrualCycleHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.electrocardiogram.created:
post:
tags:
- summary
summary: Electrocardiogram Historical Pull Completed
operationId: electrocardiogram_historical_pull_completedhistorical_data_electrocardiogram_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingElectrocardiogramHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
continuous_query.result_table.changed:
post:
tags:
- aggregation
summary: Result Table Changed
operationId: result_table_changedcontinuous_query_result_table_changed_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingContinuousQueryResultTableChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
provider.connection.created:
post:
tags:
- link
summary: Provider Connection Created
operationId: provider_connection_createdprovider_connection_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingProviderConnectionCreatedEvent'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
provider.connection.error:
post:
tags:
- link
summary: Provider Connection Error
operationId: provider_connection_errorprovider_connection_error_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingProviderConnectionErrorEvent'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
provider.device.*:
post:
tags:
- summary
summary: Provider Device Created
operationId: provider_device_createdprovider_device___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingDeviceChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
labtest.order.*:
post:
tags:
- lab-testing
summary: Order
operationId: orderlabtest_order___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingOrderChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
labtest.appointment.*:
post:
tags:
- lab-testing
summary: Appointment
operationId: appointmentlabtest_appointment___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingAppointmentChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
labtest.result.critical:
post:
tags:
- lab-testing
summary: Critical Result
operationId: critical_resultlabtest_result_critical_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingCriticalResultIdentified'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
lab_report.parsing_job.created:
post:
tags:
- lab-testing
summary: Lab Report Parsing Job Created
operationId: lab_report_parsing_job_createdlab_report_parsing_job_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingLabReportParsingJobCreatedEvent'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
lab_report.parsing_job.updated:
post:
tags:
- lab-testing
summary: Lab Report Parsing Job Updated
operationId: lab_report_parsing_job_updatedlab_report_parsing_job_updated_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingLabReportParsingJobUpdatedEvent'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.calories_active.*:
post:
tags:
- timeseries
summary: Calories Active
operationId: calories_activedaily_data_calories_active___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingCaloriesActiveChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.calories_active.created:
post:
tags:
- timeseries
summary: Calories Active Historical Pull Completed
operationId: calories_active_historical_pull_completedhistorical_data_calories_active_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingCaloriesActiveHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.calories_basal.*:
post:
tags:
- timeseries
summary: Calories Basal
operationId: calories_basaldaily_data_calories_basal___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingCaloriesBasalChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.calories_basal.created:
post:
tags:
- timeseries
summary: Calories Basal Historical Pull Completed
operationId: calories_basal_historical_pull_completedhistorical_data_calories_basal_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingCaloriesBasalHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.blood_pressure.*:
post:
tags:
- timeseries
summary: Blood Pressure
operationId: blood_pressuredaily_data_blood_pressure___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBloodPressureChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.blood_pressure.created:
post:
tags:
- timeseries
summary: Blood Pressure Historical Pull Completed
operationId: blood_pressure_historical_pull_completedhistorical_data_blood_pressure_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBloodPressureHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.blood_oxygen.*:
post:
tags:
- timeseries
summary: Blood Oxygen
operationId: blood_oxygendaily_data_blood_oxygen___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBloodOxygenChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.blood_oxygen.created:
post:
tags:
- timeseries
summary: Blood Oxygen Historical Pull Completed
operationId: blood_oxygen_historical_pull_completedhistorical_data_blood_oxygen_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingBloodOxygenHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.weight.*:
post:
tags:
- timeseries
summary: Weight
operationId: weightdaily_data_weight___post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWeightChanged'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
historical.data.weight.created:
post:
tags:
- timeseries
summary: Weight Historical Pull Completed
operationId: weight_historical_pull_completedhistorical_data_weight_created_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClientFacingWeightHistoricalPullCompleted'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema: {}
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
daily.data.fat.*:
post:
tags:
- timeseries
summary: Fat
operationId: fatdaily_data_fat___post
requestBody:
# --- truncated at 32 KB (682 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vital-io/refs/heads/main/openapi/vital-sense-api-openapi.yml