How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vital Aggregate API

The Aggregate API from Vital — 3 operation(s) for aggregate.

Vital Aggregate API is one of 18 APIs that Vital publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 7 JSON Schema definitions.

Tagged areas include Aggregate. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 3 operations across 3 paths, and defines 55 schemas. It is described by OpenAPI 3.1.0, at version 0.4.497.

Requests are made against 4 base URLs: https://api.us.junction.com, https://api.eu.junction.com, https://api.sandbox.us.junction.com, https://api.sandbox.eu.junction.com.

3 operations 3 paths 55 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.4.497
Base URL
https://api.us.junction.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Vital Aggregate API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-vital-api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — Vital Team API Key

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Aggregate 3
POST
/aggregate/v1/user/{user_id}/query
Query One
query_one_aggregate_v1_user__user_id__query_post 2 params body → 200422
GET
/aggregate/v1/user/{user_id}/continuous_query/{query_id_or_slug}/result_table
Get Result Table For Query
get_result_table_for_query_aggregate_v1_user__user_id__continuous_query__query_id_or_slug__result_table_get 3 params → 200422
GET
/aggregate/v1/user/{user_id}/continuous_query/{query_id_or_slug}/task_history
Get Task History For Query
get_task_history_for_query_aggregate_v1_user__user_id__continuous_query__query_id_or_slug__task_history_get 4 params → 200422

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are ContinuousQueryTaskHistoryEntry (7 properties), Query (3 properties), QueryBatch (3 properties), RelativeTimeframe (3 properties). Each schema is shown below with its type and property counts.

BloodPressureTimeseriesExpr
object
2 properties 2 required
Period
object
2 properties 1 required
Query
object
3 properties 1 required
MCHomePregnancyTestFieldExpr
object
2 properties 1 required
DatePartExpr
object
2 properties 2 required
MCOvulationTestFieldExpr
object
2 properties 1 required
Labs
string
ℹ️ This enum is non-exhaustive.
WorkoutDurationTimeseriesExpr
object
2 properties 2 required
ChronotypeValueMacroExpr
object
2 properties 1 required
AggregateFieldExpr
object
Aggregate over unnested list elements, optionally targeting a struct field. When arg is None, the aggregate operates on the list elements directly (e.g., count…
2 properties 1 required
MCBasalBodyTemperatureFieldExpr
object
2 properties 1 required
SleepScoreValueMacroExpr
object
2 properties 1 required
ContinuousQueryTaskStatus
string
ℹ️ This enum is non-exhaustive.
IntervalTimeseriesExpr
object
2 properties 2 required
DerivedReadinessColumnExpr
object
1 property 1 required
MCDetectedDeviationsFieldExpr
object
2 properties 1 required
QueryBatch
object
3 properties 2 required
IndexColumnExpr
object
1 property 1 required
DateTruncExpr
object
2 properties 2 required
MenstrualCycleColumnExpr
object
1 property 1 required
ContinuousQueryTaskHistoryResponse
object
2 properties 2 required
AggregationResult
object
1 property 1 required
UnnestExpr
object
FROM clause variant: unnest a list column into elements.
1 property 1 required
WorkoutColumnExpr
object
1 property 1 required
AsleepAtValueMacroExpr
object
2 properties 1 required
MCCervicalMucusFieldExpr
object
2 properties 1 required
MCContraceptiveFieldExpr
object
2 properties 1 required
Providers
string
ℹ️ This enum is non-exhaustive.
MCSexualActivityFieldExpr
object
2 properties 1 required
HTTPValidationError
object
1 property
UnrecognizedValueMacroExpr
object
1 property 1 required
ElementFieldExpr
object
References the element itself in a scalar-element list subquery arg. Symmetric with the reserved element keyword in WHERE predicates. Only valid when the UNNES…
1 property 1 required
TemperatureTimeseriesExpr
object
2 properties 2 required
MealColumnExpr
object
1 property 1 required
ProfileColumnExpr
object
1 property 1 required
GroupKeyColumnExpr
object
1 property 1 required
ScalarOutputSubqueryExpr
object
A subquery that produces a single scalar value per row.
3 properties 2 required
MCMenstrualFlowFieldExpr
object
2 properties 1 required
AggregationResponse
object
1 property 1 required
SourceColumnExpr
object
1 property 1 required
NoteTimeseriesExpr
object
2 properties 2 required
MCIntermenstrualBleedingFieldExpr
object
2 properties 1 required
AwakeningsValueMacroExpr
object
2 properties 1 required
MCHomeProgesteroneTestFieldExpr
object
2 properties 1 required
AwakeAtValueMacroExpr
object
2 properties 1 required
ActivityColumnExpr
object
1 property 1 required
DiscreteTimeseriesExpr
object
2 properties 2 required
BodyColumnExpr
object
1 property 1 required
Placeholder
object
1 property 1 required
InsulinInjectionTimeseriesExpr
object
2 properties 2 required
RelativeTimeframe
object
3 properties 3 required
AggregateExpr
object
2 properties 2 required
QueryConfig
object
1 property
ContinuousQueryTaskHistoryEntry
object
7 properties 7 required
SleepColumnExpr
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vital-io-aggregate-api-openapi.yml Raw ↑

Other APIs Vital publishes across the network.

Vital Management API
Vital compendium API
Vital insurance API
Vital introspect API
Vital lab_account API
Vital lab_report API
Vital lab_tests API
Vital link API
Vital order API
Vital order_transaction API
Vital orders API
Vital payor API
Where this information came from

This is an independent, third-party profile of Vital Aggregate API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.