Validic Inform

Validic Inform Developer Hub

Welcome to the Validic Inform developer hub. You'll find comprehensive guides and documentation to help you start working with Validic Inform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Validic collects data from wearables, apps and in-home medical devices. This data is standardized into the various Metric types shown below. Metrics are grouped into Resources, such as “workouts” or “nutrition”, when presented via the API.

The supported list of metric types is listed below. While it is possible for any Metric Type to appear as part of any API Resource, the most common types of each API Resource are provided in the Resource section.

Working with Metrics

The Validic API supports a variety of metric types in an effort to succinctly present data recorded by a user. Each source (app, device, etc.) may have different representations of the same resource object and therefore, Validic does not define which metrics are presented as part of a provided resource object. Any supported metric may exist within any resource record for a user, in addition to any segment of a resource where provided. For example, a summary record and a workout record can both contain a metric type of steps. This allows the customer to receive a complete set of metrics for every record every time. When ingesting data off the Stream or RESTful APIs, the developer can iterate through the list of metrics verifying each type to determine whether or not the metric contains data relevant to their use case.

TypeCommonly FoundDefinitionData TypeReported UnitsStandardaized Unit
active_durationSummaries, WorkoutsTotal duration of active time as defined by the source.floats ms min hs
active_energy_burnedSummariesThe number of active calories burned as defined by the source.floatkcal kJ Jkcal
avg_cadenceWorkoutsThe average revolutions per minute on a bike, strides per minute on a run, or strokes per minute during a swim.floatr/min SPMn/a
avg_heart_rateSummaries, WorkoutsThe average heart rate measured as determined by the source.integerbpmbpm
avg_powerWorkoutsThe average power measurement.floatWW
avg_speedWorkoutsThe cumulative average speed measurement as determined by the source.floatm/s mi/s mph kphm/s
awake_countSleepThe number of instances the individual was awake during the designated sleep period as determined by the source.integercountcount
awake_durationSleepThe duration of time the user was awake during the sleep period as defined by the device.floats ms min hs
basal_energy_burnedSummariesThe number of bmr calories burned as defined by the source.floatkcal kJ Jkcal
blood_glucoseMeasurementsBlood glucose, or blood sugar, reading of the individual. May be an individual measurement or an average of multiple consecutive readings taken within a short period of time, as defined by the source.floatmg/dL mmol/Ln/a
bmiMeasurementsBody Mass Index. Calculated as weight in kg divided by height in m squaredfloatkg/m2kg/m2
body_armsMeasurementsBody arm circumference of the individual.floatcm incm
body_chestMeasurementsBody chest circumference of the individual.floatcm incm
body_fatMeasurementsBody Fat Percentage. Calculated as body fat mass divided by total body mass. Often estimated by devices.floatpercentpercent
body_heightMeasurementsBody height measurement of the individual.floatft mm
body_hipsMeasurementsBody hip circumference of the individual.floatcm incm
body_temperatureMeasurementsThe body temperature measurement of the individual.floatC FC
body_thighsMeasurementsBody thigh circumference of the individual.floatcm incm
body_waistMeasurementsBody waist circumference of the individual.floatcm incm
body_weightMeasurementsBody weight measurement of the individual.floatg kg lb stkg
calciumNutritionThe value of the measured quantity in milligrams.floatmgmg
carbohydrateNutritionThe value of measured quantity in grams.floatgg
cholesterolNutritionThe value of the measured quantity in milligrams.floatmgmg
deep_sleepSleepThe duration of time the individual was in a deep sleep state as defined by the source.floats ms min hs
diastolicMeasurementsThe diastolic blood pressure measurement of the individual.floatmmHg KPammHg
dietary_fiberNutritionThe value of the measured quantity in grams.floatgg
distanceSummaries, WorkoutsThe distance traveled as defined by the source.floatm ft mi km ydm
elevationSummariesThe elevation changed as defined by the source.floatm ft mi km ydm
energy_burnedSummaries, WorkoutsTotal number of calories burned as defined by the source or calculated by Validic.floatkcal kJ Jkcal
energy_consumedNutritionThe total number of calories, or "energy," consumed.floatkcal kJ Jkcal
fatNutritionThe value of measured quantity in gram.floatgg
floors_climbedSummariesTotal number of floors climbed as defined by the source.integercountcount
heart_rate_variabilitySleepThe heart rate variability of the individual during the sleep period as determined by the source.integerbpmbpm
heart_rate_zone_highSummaries, WorkoutsThe time spent in a high heart rate zone as determined by the source or Validic's algorithm.floatns ms s mins
heart_rate_zone_lowSummaries, WorkoutsThe time spent in a low heart rate zone as determined by the source or Validic's algorithm.floatns ms s mins
heart_rate_zone_mediumSummaries, WorkoutsThe time spent in a medium heart rate zone as determined by the source or Validic's algorithm.floatns ms s mins
heart_rate_zone_very_lowSummaries, WorkoutsThe time spent in a very low heart rate zone as determined by the source or Validic's algorithm.floatns ms s mins
in_bed_durationSleepThe duration of time the individual was in bed during the sleep period as defined by the sourcefloats ms min hs
insulinMeasurementsThe amount of insulin consumed by an individual.floatIUIU
lapsWorkoutsThe number of laps taken as defined by the source.integercountcount
light_sleepSleepThe duration of time the individual was in a light sleep state as defined by the source.floats ms min hs
max_heart_rateSummaries, WorkoutsThe maximum heart rate measured as determined by the source.integerbpmbpm
max_speedWorkoutsThe highest discrete speed measurement.floatm/s mi/s mph kphm/s
min_heart_rateSummaries, WorkoutsThe minimum heart rate measured as determined by the source.integerbpmbpm
proteinNutritionThe value of measured quantity in grams.floatgg
pulseMeasurementsThe heart rate reading of the individual.integerbpmbpm
rem_sleepSleepThe duration of time the individual was in a REM sleep state as defined by the source.floats ms min hs
resting_heart_rateSummariesThe waking heart rate measurement of the individual as determined by the source.integerbpmbpm
restless_countSleepThe number of times moved into a restless state as defined by the device during a sleep period.integercountcount
saturated_fatNutritionTotal saturated fat consumed.floatgg
sleep_durationSleepThe duration of time the user was sleeping during the sleep period as defined by the device.floats ms min hs
sleep_scoreSleepSleep efficiency as calculated by the source.floatpercentpercent
sodiumNutritionThe value of measured quantity in grams.floatg mgmg
spo2MeasurementsBlood oxygen saturation of the individual.floatpercentpercent
stepsSummaries, WorkoutsThe number of steps taken in a single day as defined by the source. For sources that show only routine, non-workout steps as the daily step count, this value will match the steps shown by the source to the end user.integercountcount
sugarsNutritionThe amount of sugars that are either added during the processing of foods, or are packaged as such.floatgg
systolicMeasurementsThe systolic blood pressure measurement of the individual.floatmmHg KPammHg
time_to_fall_asleepSleepTime it took the individual to fall asleepfloats ms min hs
unsaturated_fatNutritionTotal unsaturated fat consumed.floatgg
waterNutritionTotal amount of water consumed as defined by the source.floatmL fl ozmL

Metrics