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 timeseries API

The timeseries API from Vital — 80 operation(s) for timeseries.

Vital timeseries 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 Time Series. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 7 JSON Schemas.

This API exposes 80 operations across 80 paths, and defines 158 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.

80 operations 80 paths 158 schemas 80 GET

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 timeseries 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 80

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

timeseries 80
GET
/v2/timeseries/sleep/{sleep_id}/stream
Get User Sleep Stream
get_user_sleep_stream_v2_timeseries_sleep__sleep_id__stream_get 1 param → 200422
GET
/v2/timeseries/workouts/{workout_id}/stream
Get User Workouts
get_user_workouts_v2_timeseries_workouts__workout_id__stream_get 1 param → 200422
GET
/v2/timeseries/{user_id}/workout_swimming_stroke/grouped
Workout Swimming Stroke
get_workout_swimming_stroke_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/workout_distance/grouped
Workout Distance
get_workout_distance_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/heart_rate_recovery_one_minute/grouped
Heart Rate Recovery One Minute
get_heart_rate_recovery_one_minute_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/waist_circumference/grouped
Waist Circumference
get_waist_circumference_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/lean_body_mass/grouped
Lean Body Mass
get_lean_body_mass_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/body_mass_index/grouped
Body Mass Index
get_body_mass_index_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/basal_body_temperature/grouped
Basal Body Temperature
get_basal_body_temperature_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/handwashing/grouped
Handwashing
get_handwashing_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/daylight_exposure/grouped
Daylight Exposure
get_daylight_exposure_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/uv_exposure/grouped
Uv Exposure
get_uv_exposure_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/fall/grouped
Fall
get_fall_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/inhaler_usage/grouped
Inhaler Usage
get_inhaler_usage_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/peak_expiratory_flow_rate/grouped
Peak Expiratory Flow Rate
get_peak_expiratory_flow_rate_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/forced_vital_capacity/grouped
Forced Vital Capacity
get_forced_vital_capacity_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/forced_expiratory_volume_1/grouped
Forced Expiratory Volume 1
get_forced_expiratory_volume_1_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/wheelchair_push/grouped
Wheelchair Push
get_wheelchair_push_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/sleep_breathing_disturbance/grouped
Sleep Breathing Disturbance
get_sleep_breathing_disturbance_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/sleep_apnea_alert/grouped
Sleep Apnea Alert
get_sleep_apnea_alert_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/stand_duration/grouped
Stand Duration
get_stand_duration_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/stand_hour/grouped
Stand Hour
get_stand_hour_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/heart_rate_alert/grouped
Heart Rate Alert
get_heart_rate_alert_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/afib_burden/grouped
Afib Burden
get_afib_burden_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/workout_duration/grouped
Workout Duration
get_workout_duration_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/vo2_max/grouped
Vo2 Max
get_vo2_max_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/stress_level/grouped
Stress Level
get_stress_level_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/mindfulness_minutes/grouped
Mindfulness Minutes
get_mindfulness_minutes_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/caffeine/grouped
Caffeine
get_caffeine_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/water/grouped
Water
get_water_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/steps/grouped
Steps
get_steps_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/floors_climbed/grouped
Floors Climbed
get_floors_climbed_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/distance/grouped
Distance
get_distance_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/calories_basal/grouped
Calories Basal
get_calories_basal_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/calories_active/grouped
Calories Active
get_calories_active_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/respiratory_rate/grouped
Respiratory Rate
get_respiratory_rate_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/note/grouped
Note
get_note_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/insulin_injection/grouped
Insulin Injection
get_insulin_injection_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/ige/grouped
Ige
get_ige_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/igg/grouped
Igg
get_igg_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/hypnogram/groupeddeprecated
Hypnogram
get_hypnogram_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/hrv/grouped
Heart Rate Variability
get_hrv_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/heartrate/grouped
Heart Rate
get_heartrate_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/glucose/grouped
Glucose
get_glucose_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/cholesterol/grouped
Cholesterol
get_cholesterol_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/carbohydrates/grouped
Carbohydrates
get_carbohydrates_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/body_temperature_delta/grouped
Body Temperature Delta
get_body_temperature_delta_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/body_temperature/grouped
Body Temperature
get_body_temperature_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/body_weight/grouped
Body Weight
get_body_weight_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/body_fat/grouped
Body Fat
get_body_fat_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/blood_oxygen/grouped
Blood Oxygen
get_blood_oxygen_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/electrocardiogram_voltage/grouped
Electrocardiogram Voltage
get_electrocardiogram_voltage_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/blood_pressure/grouped
Blood Pressure
get_blood_pressure_grouped 6 params → 200422
GET
/v2/timeseries/{user_id}/vo2_maxdeprecated
Vo2 Max
get_vo2_max 4 params → 200422
GET
/v2/timeseries/{user_id}/stress_leveldeprecated
Stress Level
get_stress_level 4 params → 200422
GET
/v2/timeseries/{user_id}/mindfulness_minutesdeprecated
Mindfulness Minutes
get_mindfulness_minutes 4 params → 200422
GET
/v2/timeseries/{user_id}/caffeinedeprecated
Caffeine
get_caffeine 4 params → 200422
GET
/v2/timeseries/{user_id}/waterdeprecated
Water
get_water 4 params → 200422
GET
/v2/timeseries/{user_id}/stepsdeprecated
Steps
get_steps 4 params → 200422
GET
/v2/timeseries/{user_id}/floors_climbeddeprecated
Floors Climbed
get_floors_climbed 4 params → 200422
GET
/v2/timeseries/{user_id}/distancedeprecated
Distance
get_distance 4 params → 200422
GET
/v2/timeseries/{user_id}/calories_basaldeprecated
Calories Basal
get_calories_basal 4 params → 200422
GET
/v2/timeseries/{user_id}/calories_activedeprecated
Calories Active
get_calories_active 4 params → 200422
GET
/v2/timeseries/{user_id}/respiratory_ratedeprecated
Respiratory Rate
get_respiratory_rate 4 params → 200422
GET
/v2/timeseries/{user_id}/igedeprecated
Ige
get_ige 4 params → 200422
GET
/v2/timeseries/{user_id}/iggdeprecated
Igg
get_igg 4 params → 200422
GET
/v2/timeseries/{user_id}/hypnogramdeprecated
Hypnogram
get_hypnogram 4 params → 200422
GET
/v2/timeseries/{user_id}/hrvdeprecated
Heart Rate Variability
get_hrv 4 params → 200422
GET
/v2/timeseries/{user_id}/heartratedeprecated
Heart Rate
get_heartrate 4 params → 200422
GET
/v2/timeseries/{user_id}/glucosedeprecated
Glucose
get_glucose 4 params → 200422
GET
/v2/timeseries/{user_id}/cholesterol/triglyceridesdeprecated
Cholesterol/Triglycerides
get_cholesterol/triglycerides 4 params → 200422
GET
/v2/timeseries/{user_id}/cholesterol/totaldeprecated
Cholesterol/Total
get_cholesterol/total 4 params → 200422
GET
/v2/timeseries/{user_id}/cholesterol/ldldeprecated
Cholesterol/Ldl
get_cholesterol/ldl 4 params → 200422
GET
/v2/timeseries/{user_id}/cholesterol/hdldeprecated
Cholesterol/Hdl
get_cholesterol/hdl 4 params → 200422
GET
/v2/timeseries/{user_id}/cholesteroldeprecated
Cholesterol
get_cholesterol 4 params → 200422
GET
/v2/timeseries/{user_id}/body_weightdeprecated
Body Weight
get_body_weight 4 params → 200422
GET
/v2/timeseries/{user_id}/body_fatdeprecated
Body Fat
get_body_fat 4 params → 200422
GET
/v2/timeseries/{user_id}/blood_oxygendeprecated
Blood Oxygen
get_blood_oxygen 4 params → 200422
GET
/v2/timeseries/{user_id}/electrocardiogram_voltagedeprecated
Electrocardiogram Voltage
get_electrocardiogram_voltage 4 params → 200422
GET
/v2/timeseries/{user_id}/blood_pressuredeprecated
Blood Pressure
get_blood_pressure 4 params → 200422

Schemas 158

The contract defines 158 schemas that model the data the API accepts and returns. The most detailed are ClientFacingStream (11 properties), ClientFacingInsulinInjectionSample (11 properties), ClientFacingNoteSample (9 properties), ClientFacingBodyTemperatureDeltaSample (9 properties). Each schema is shown below with its type and property counts.

GroupedDaylightExposure
object
2 properties 2 required
ClientFacingCaffeineTimeseries
object
8 properties 5 required
ClientFacingHRVTimeseries
object
6 properties 3 required
ClientFacingFallSample
object
8 properties 5 required
ClientFacingNoteSample
object
9 properties 5 required
GroupedInsulinInjectionResponse
object
3 properties 1 required
GroupedBloodPressureResponse
object
3 properties 1 required
ClientFacingGlucoseTimeseries
object
6 properties 3 required
GroupedForcedVitalCapacityResponse
object
3 properties 1 required
ClientFacingInsulinInjectionSample
object
11 properties 6 required
GroupedStandDuration
object
2 properties 2 required
GroupedDistanceResponse
object
3 properties 1 required
GroupedFallResponse
object
3 properties 1 required
GroupedRespiratoryRate
object
2 properties 2 required
GroupedUVExposure
object
2 properties 2 required
GroupedBasalBodyTemperatureResponse
object
3 properties 1 required
ClientFacingWheelchairPushSample
object
8 properties 5 required
ClientFacingForcedExpiratoryVolume1Sample
object
8 properties 5 required
GroupedElectrocardiogramVoltage
object
2 properties 2 required
ClientFacingCholesterolTimeseries
object
6 properties 4 required
GroupedHeartRateResponse
object
3 properties 1 required
GroupedNoteResponse
object
3 properties 1 required
GroupedWorkoutSwimmingStroke
object
2 properties 2 required
GroupedPeakExpiratoryFlowRateResponse
object
3 properties 1 required
ClientFacingCaloriesBasalTimeseries
object
6 properties 3 required
ClientFacingHandwashingSample
object
8 properties 5 required
GroupedWaistCircumference
object
2 properties 2 required
GroupedUVExposureResponse
object
3 properties 1 required
GroupedHRV
object
2 properties 2 required
GroupedBodyTemperatureDelta
object
2 properties 2 required
GroupedDistance
object
2 properties 2 required
GroupedGlucoseResponse
object
3 properties 1 required
ClientFacingPeakExpiratoryFlowRateSample
object
8 properties 5 required
GroupedBodyFatResponse
object
3 properties 1 required
GroupedHeartRateAlertResponse
object
3 properties 1 required
GroupedCaloriesBasalResponse
object
3 properties 1 required
GroupedMindfulnessMinutesResponse
object
3 properties 1 required
GroupedIggResponse
object
3 properties 1 required
GroupedForcedVitalCapacity
object
2 properties 2 required
GroupedCaffeineResponse
object
3 properties 1 required
ClientFacingBodyFatTimeseries
object
6 properties 3 required
ClientFacingDistanceTimeseries
object
8 properties 5 required
_ClientFacingSampleGroupingKeys
array
ClientFacingForcedVitalCapacitySample
object
8 properties 5 required
ClientFacingSleepBreathingDisturbanceSample
object
8 properties 6 required
ClientFacingBasalBodyTemperatureSample
object
8 properties 5 required
GroupedWorkoutDurationResponse
object
3 properties 1 required
ClientFacingWaterTimeseries
object
6 properties 3 required
ClientFacingBloodOxygenTimeseries
object
6 properties 3 required
ClientFacingCaloriesActiveTimeseries
object
8 properties 5 required
GroupedWater
object
2 properties 2 required
GroupedStressLevel
object
2 properties 2 required
GroupedWaterResponse
object
3 properties 1 required
GroupedRespiratoryRateResponse
object
3 properties 1 required
GroupedBloodPressure
object
2 properties 2 required
GroupedBodyMassIndexResponse
object
3 properties 1 required
GroupedFall
object
2 properties 2 required
GroupedIge
object
2 properties 2 required
ClientFacingSource
object
Source summarizes where a sample or a summary is sourced from. At minimum, the source provider is always included.
9 properties 1 required
ClientFacingIggTimeseries
object
6 properties 4 required
HTTPValidationError
object
1 property
GroupedSleepBreathingDisturbance
object
2 properties 2 required
ClientFacingBodyWeightTimeseries
object
6 properties 3 required
GroupedSleepApneaAlert
object
2 properties 2 required
GroupedCaloriesActive
object
2 properties 2 required
GroupedBodyWeight
object
2 properties 2 required
GroupedStepsResponse
object
3 properties 1 required
GroupedGlucose
object
2 properties 2 required
GroupedSleepBreathingDisturbanceResponse
object
3 properties 1 required
ClientFacingHeartRateRecoveryOneMinuteSample
object
8 properties 5 required
ClientFacingFloorsClimbedTimeseries
object
6 properties 3 required
ClientFacingSleepStream
object
4 properties
ClientFacingStandHourSample
object
8 properties 6 required
GroupedLeanBodyMassResponse
object
3 properties 1 required
GroupedFloorsClimbed
object
2 properties 2 required
ClientFacingWaistCircumferenceSample
object
8 properties 5 required
GroupedPeakExpiratoryFlowRate
object
2 properties 2 required
ClientFacingAFibBurdenSample
object
8 properties 5 required
GroupedCaffeine
object
2 properties 2 required
ClientFacingRespiratoryRateTimeseries
object
6 properties 3 required
GroupedHandwashingResponse
object
3 properties 1 required
GroupedBodyTemperatureResponse
object
3 properties 1 required
GroupedVO2Max
object
2 properties 2 required
GroupedWorkoutDistanceResponse
object
3 properties 1 required
GroupedBloodOxygen
object
2 properties 2 required
ClientFacingVO2MaxTimeseries
object
8 properties 5 required
GroupedBodyTemperatureDeltaResponse
object
3 properties 1 required
GroupedCholesterolResponse
object
3 properties 1 required
GroupedHypnogramResponse
object
3 properties 1 required
GroupedAFibBurdenResponse
object
3 properties 1 required
ClientFacingHypnogramTimeseries
object
8 properties 5 required
GroupedCarbohydrates
object
2 properties 2 required
GroupedVO2MaxResponse
object
3 properties 1 required
ClientFacingLeanBodyMassSample
object
8 properties 5 required
GroupedCarbohydratesResponse
object
3 properties 1 required
ClientFacingWorkoutSwimmingStrokeSample
object
8 properties 5 required
GroupedForcedExpiratoryVolume1Response
object
3 properties 1 required
GroupedSleepApneaAlertResponse
object
3 properties 1 required
GroupedForcedExpiratoryVolume1
object
2 properties 2 required
ClientFacingBodyTemperatureDeltaSample
object
9 properties 6 required
ClientFacingStream
object
11 properties
GroupedCaloriesActiveResponse
object
3 properties 1 required
GroupedWaistCircumferenceResponse
object
3 properties 1 required
GroupedElectrocardiogramVoltageResponse
object
3 properties 1 required
GroupedHypnogram
object
2 properties 2 required
GroupedBodyMassIndex
object
2 properties 2 required
GroupedHeartRate
object
2 properties 2 required
GroupedInsulinInjection
object
2 properties 2 required
GroupedNote
object
2 properties 2 required
GroupedStandHour
object
2 properties 2 required
ClientFacingBodyTemperatureSample
object
9 properties 6 required
GroupedHeartRateAlert
object
2 properties 2 required
GroupedCholesterol
object
2 properties 2 required
GroupedWorkoutDistance
object
2 properties 2 required
ClientFacingDaylightExposureSample
object
8 properties 5 required
GroupedDaylightExposureResponse
object
3 properties 1 required
ClientFacingUVExposureSample
object
8 properties 5 required
ClientFacingHeartRateTimeseries
object
6 properties 3 required
GroupedInhalerUsage
object
2 properties 2 required
ClientFacingBloodPressureTimeseries
object
8 properties 4 required
GroupedInhalerUsageResponse
object
3 properties 1 required
GroupedWorkoutSwimmingStrokeResponse
object
3 properties 1 required
GroupedIgeResponse
object
3 properties 1 required
ClientFacingInhalerUsageSample
object
8 properties 5 required
GroupedFloorsClimbedResponse
object
3 properties 1 required
GroupedStandDurationResponse
object
3 properties 1 required
ClientFacingStressLevelTimeseries
object
6 properties 3 required
GroupedWheelchairPush
object
2 properties 2 required
GroupedBodyWeightResponse
object
3 properties 1 required
ClientFacingSleepApneaAlertSample
object
8 properties 5 required
GroupedHandwashing
object
2 properties 2 required
ClientFacingStandDurationSample
object
8 properties 5 required
GroupedIgg
object
2 properties 2 required
GroupedLeanBodyMass
object
2 properties 2 required
GroupedCaloriesBasal
object
2 properties 2 required
GroupedSteps
object
2 properties 2 required
GroupedBodyTemperature
object
2 properties 2 required
ClientFacingBodyMassIndexSample
object
8 properties 5 required
GroupedStressLevelResponse
object
3 properties 1 required
GroupedWheelchairPushResponse
object
3 properties 1 required
ClientFacingCarbohydratesSample
object
8 properties 5 required
GroupedAFibBurden
object
2 properties 2 required
ClientFacingStepsTimeseries
object
8 properties 5 required
GroupedStandHourResponse
object
3 properties 1 required
GroupedHRVResponse
object
3 properties 1 required
GroupedHeartRateRecoveryOneMinuteResponse
object
3 properties 1 required
GroupedBodyFat
object
2 properties 2 required
GroupedHeartRateRecoveryOneMinute
object
2 properties 2 required
GroupedWorkoutDuration
object
2 properties 2 required
GroupedBasalBodyTemperature
object
2 properties 2 required
GroupedBloodOxygenResponse
object
3 properties 1 required
ClientFacingHeartRateAlertSample
object
8 properties 6 required
ClientFacingWorkoutDistanceSample
object
8 properties 5 required
ClientFacingMindfulnessMinutesTimeseries
object
8 properties 5 required
GroupedMindfulnessMinutes
object
2 properties 2 required
ClientFacingElectrocardiogramVoltageTimeseries
object
6 properties 4 required
ClientFacingWorkoutDurationSample
object
9 properties 6 required
ClientFacingIgeTimeseries
object
6 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Vital publishes across the network.

Vital Management API
Vital Aggregate 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
Where this information came from

This is an independent, third-party profile of Vital timeseries 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.