Metrics
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.
| Type | Commonly Found | Definition | Data Type | Units | Standard Unit |
|---|---|---|---|---|---|
| active_duration | Summaries, Workouts | Total duration of active time as defined by the source. | float | s ms min h | s |
| active_energy_burned | Summaries | The number of active calories burned as defined by the source. | float | kcal kJ J | kcal |
| avg_blood_glucose | Measurements | The average blood glucose measured as determined by the source. | float | mg/dL mmol/L | n/a |
| avg_cadence | Workouts | The average cadence as recorded by the source. Could represent revolutions per minute on a bike, strides per minute on a run, strokes per minute during a swim, and more. | float | r/min SPM | n/a |
| avg_heart_rate | Summaries, Workouts, Measurements, Intraday | The average heart rate measured as determined by the source. | integer | bpm | bpm |
| avg_pace | Workouts | The average pace as recorded by the source. | float | min/km | n/a |
| avg_power | Workouts | The average power measurement. | float | W | W |
| avg_speed | Workouts | The cumulative average speed measurement as determined by the source. | float | m/s mi/s mph kph | m/s |
| avg_spo2 | Summaries | The average blood oxygen saturation of the individual. Measured as defined by the source. | float | percent | percent |
| awake_count | Sleep | The number of instances the individual was awake during the designated sleep period as determined by the source. | integer | count | count |
| awake_duration | Sleep | The duration of time the user was awake during the sleep period as defined by the device. | float | s ms min h | s |
| basal_energy_burned | Summaries | The number of bmr calories burned as defined by the source. | float | kcal kJ J | kcal |
| blood_glucose | Measurements, CGM | Blood 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. | float | mg/dL mmol/L | n/a |
| blood_ketone | Measurements | Blood ketone 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. | float | mg/dL mmol/L | n/a |
| bmi | Measurements | Body Mass Index. Calculated as weight in kg divided by height in m squared | float | kg/m2 | kg/m2 |
| body_arms | Measurements | Body arm circumference of the individual. | float | cm in | cm |
| body_bone | Measurements | Body Bone Percentage. Calculated as bone mass divided by total body mass. | float | percent | percent |
| body_bone_mass | Measurements | Body Bone Mass is the total amount of mass attributed to bone. | float | g kg lb st | kg |
| body_chest | Measurements | Body chest circumference of the individual. | float | cm in | cm |
| body_fat | Measurements | Body Fat Percentage. Calculated as body fat mass divided by total body mass. Often estimated by devices. | float | percent | percent |
| body_fat_mass | Measurements | Body Fat Mass is the total amount of mass attributed to fat. | float | g kg lb st | kg |
| body_height | Measurements | Body height measurement of the individual. | float | ft m cm | m |
| body_hips | Measurements | Body hip circumference of the individual. | float | cm in | cm |
| body_lean_mass | Measurements | Body Lean Mass is the total amount of non fat mass. | float | g kg lb st | kg |
| body_muscle | Measurements | Body Muscle Percentage. Calculated as muscle mass divided by total body mass. | float | percent | percent |
| body_muscle_mass | Measurements | Body Muscle Mass is the total amount of mass attributed to muscle. | float | g kg lb st | kg |
| body_temperature | Measurements | The body temperature measurement of the individual. | float | C F | C |
| body_temperature_deviation | Summaries | The body temperature deviation of the individual as defined by the source. | float | C F | C |
| body_thighs | Measurements | Body thigh circumference of the individual. | float | cm in | cm |
| body_waist | Measurements | Body waist circumference of the individual. | float | cm in | cm |
| body_water | Measurements | Body Water Percentage. Calculated as water mass divided by total body mass. | float | percent | percent |
| body_water_mass | Measurements | Body Water Mass is the total amount of mass attributed to water. | float | g kg lb st | kg |
| body_weight | Measurements | Body weight measurement of the individual. | float | g kg lb st | kg |
| calcium | Nutrition | The value of the measured quantity in milligrams. | float | mg | mg |
| capture_rate | Measurements | The rate of data capture of the device as determined by the source. | float | percent | percent |
| carbohydrate | Nutrition | The value of measured quantity in grams. | float | g | g |
| cholesterol | Nutrition | The value of the measured quantity in milligrams. | float | mg | mg |
| coefficient_of_variation | Measurements | The coefficient of variation as determined by the source. | float | percent | percent |
| days_worn_count | Measurements | The count of days in which the user wore the device as determined by the source. | integer | count | count |
| deep_sleep | Sleep | The duration of time the individual was in a deep sleep state as defined by the source. | float | s ms min h | s |
| diastolic | Measurements | The diastolic blood pressure measurement of the individual. | float | mmHg KPa | mmHg |
| dietary_fiber | Nutrition | The value of the measured quantity in grams. | float | g | g |
| distance | Summaries, Workouts, Intraday | The distance traveled as defined by the source. | float | m ft mi km yd | m |
| elevation | Summaries | The elevation changed as defined by the source. | float | m ft mi km yd | m |
| energy_burned | Summaries, Workouts | Total number of calories burned as defined by the source or calculated by Validic. | float | kcal kJ J | kcal |
| energy_consumed | Nutrition | The total number of calories, or "energy," consumed. | float | kcal kJ J | kcal |
| fairly_active_duration | Summaries, Workouts | Total duration of fairly active time as defined by the source. | float | s ms min h | s |
| fat | Nutrition | The value of measured quantity in gram. | float | g | g |
| fef_25_75 | Measurements | Forced expiratory flow (FEF) over the middle one half of the Forced Vital Capacity (FVC); the average flow from the point at which 25 percent of the FVC has been exhaled to the point at which 75 percent of the FVC has been exhaled. | float | L/s | L/s |
| fet | Measurements | Forced Expiratory Time (FET) measures the length of the expiration. | float | s | s |
| fev1 | Measurements | FEV1 is the amount of air you can force from your lungs in one second. | float | L | L |
| fev1_per_fvc | Measurements | Represents the proportion of a person's vital capacity that they are able to expire in the first second of forced expiration (FEV1) to the full, forced vital capacity (FVC). The result of this ratio is expressed as FEV1%. | float | percent | percent |
| fvc | Measurements | Forced vital capacity (FVC) is the total amount of air exhaled during the FEV test. | float | L | L |
| floors_climbed | Summaries, Intraday | Total number of floors climbed as defined by the source. | integer | count | count |
| glucose_ketone_index | Measurements | Glucose Ketone Index (GKI) as provided by the source. Typically calculated as blood glucose in mmol/L divided by blood ketone in mmol/L | float | mmol/L | n/a |
| gmi | Measurements | Glucose Management Indicator. Approximates the laboratory A1C level expected based on average glucose measured using continuous glucose monitoring (CGM) values as determined by the source. | float | percent | percent |
| heart_rate_variability | Summaries, Sleep | The heart rate variability of the individual during the period as determined by the source. | float | ms | ms |
| heart_rate_zone_high | Summaries, Workouts | The time spent in a high heart rate zone as determined by the source or Validic's algorithm. | float | ns ms s min | s |
| heart_rate_zone_low | Summaries, Workouts | The time spent in a low heart rate zone as determined by the source or Validic's algorithm. | float | ns ms s min | s |
| heart_rate_zone_medium | Summaries, Workouts | The time spent in a medium heart rate zone as determined by the source or Validic's algorithm. | float | ns ms s min | s |
| heart_rate_zone_very_low | Summaries, Workouts | The time spent in a very low heart rate zone as determined by the source or Validic's algorithm. | float | ns ms s min | s |
| high_stress_duration | Summaries | Total duration of time that stress measurements were in a high stress range as defined by the source. | float | s, ms, min, h | s |
| hyperglycemic_count | Measurements | The number of instances of hyperglycemic measures during the designated period as determined by the source. | integer | count | count |
| hypoglycemic_count | Measurements | The number of instances of hypoglycemic measures during the designated period as determined by the source. | integer | count | count |
| idle_hours_count | Summaries | The count of hours in which the user didn’t stand up and move for at least one continuous minute during the hour. | integer | count | count |
| in_bed_duration | Sleep | The duration of time the individual was in bed during the sleep period as defined by the source | float | s ms min h | s |
| inr | Measurements | The international normalised ratio (INR) tells you how long it takes for your blood to clot. | float | scale | scale |
| insulin | Measurements | The amount of insulin consumed by an individual. | float | IU | IU |
| laps | Workouts | The number of laps taken as defined by the source. | integer | count | count |
| light_sleep | Sleep | The duration of time the individual was in a light sleep state as defined by the source. | float | s ms min h | s |
| lightly_active_duration | Summaries, Workouts | Total duration of lightly active time as defined by the source. | float | s ms min h | s |
| low_stress_duration | Summaries | Total duration of time that stress measurements were in a low stress range as defined by the source. | float | s, ms, min, h | s |
| max_cadence | Workouts | The maximum cadence as recorded by the source. Could represent revolutions per minute on a bike, strides per minute on a run, strokes per minute during a swim, and more. | float | r/min, SPM, pushes/min | n/a |
| max_heart_rate | Summaries, Workouts, Measurements | The maximum heart rate measured as determined by the source. | integer | bpm | bpm |
| max_pace | Workouts | The maximum pace as recorded by the source. | float | min/km | n/a |
| max_speed | Workouts | The highest discrete speed measurement. | float | m/s mi/s mph kph | m/s |
| max_spo2 | Summaries | The maximum blood oxygen saturation of the individual. Measured as defined by the source. | float | percent | percent |
| medium_stress_duration | Summaries | Total duration of time that stress measurements were in a medium stress range as defined by the source. | float | s, ms, min, h | s |
| min_heart_rate | Summaries, Workouts, Measurements | The minimum heart rate measured as determined by the source. | integer | bpm | bpm |
| min_spo2 | Summaries | The minimum blood oxygen saturation of the individual. Measured as defined by the source. | float | percent | percent |
| mindful_duration | Summaries | The duration in which the user was in a meditative state. | float | s ms min h | s |
| nap_duration | Sleep | The duration of time the individual was napping as defined by the source. | float | s, ms, min, h | s |
| pef | Measurements | The peak expiratory flow (PEF), also called peak expiratory flow rate (PEFR), is a person's maximum speed of expiration, as measured with a peak flow meter. | float | L/s | L/s |
| protein | Nutrition | The value of measured quantity in grams. | float | g | g |
| pulse | Measurements | The heart rate reading of the individual. | integer | bpm | bpm |
| rem_sleep | Sleep | The duration of time the individual was in a REM sleep state as defined by the source. | float | s ms min h | s |
| respiratory_rate | Summaries | The average number of breaths per minute of the individual. Measured as defined by the source. | float | b/m, b/s | n/a |
| rest_stress_duration | Summaries | Total duration of time that stress measurements were in a restful or recovery stress range as defined by the source. | float | s, ms, min, h | s |
| resting_heart_rate | Summaries | The average number of heartbeats per minute when an individual is completely at rest, measured as determined by the source during periods of inactivity. | integer | bpm | bpm |
| restless_count | Sleep | The number of times moved into a restless state as defined by the device during a sleep period. | integer | count | count |
| saturated_fat | Nutrition | Total saturated fat consumed. | float | g | g |
| scan_count | Measurements | The number of instances the device scanned for data as determined by the source. | integer | count | count |
| sleep_duration | Sleep | The duration of time the user was sleeping during the sleep period as defined by the device. | float | s ms min h | s |
| sleep_score | Sleep | Sleep efficiency as calculated by the source. | float | percent | percent |
| sodium | Nutrition | The value of measured quantity in grams. | float | g mg | mg |
| spo2 | Measurements | Blood oxygen saturation of the individual. | float | percent | percent |
| stand_hours_count | Summaries | The count of hours in which the user stood up and moved for at least one continuous minute during the hour. | integer | count | count |
| steps | Summaries, Workouts, Intraday | The 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. | integer | count | count |
| sugars | Nutrition | The amount of sugars that are either added during the processing of foods, or are packaged as such. | float | g | g |
| systolic | Measurements | The systolic blood pressure measurement of the individual. | float | mmHg KPa | mmHg |
| time_above_target | Measurements | The time above target as determined by the source based on glucose values measured using continuous glucose monitoring (CGM). | float | percent | percent |
| time_above_threshold | Measurements | The time above threshold as determined by the source based on glucose values measured using continuous glucose monitoring (CGM). | float | percent | percent |
| time_below_target | Measurements | The time below target as determined by the source based on glucose values measured using continuous glucose monitoring (CGM). | float | percent | percent |
| time_below_threshold | Measurements | The time below threshold as determined by the source based on glucose values measured using continuous glucose monitoring (CGM). | float | percent | percent |
| time_in_target | Measurements | The time in target as determined by the source based on glucose values measured using continuous glucose monitoring (CGM). | float | percent | percent |
| time_to_fall_asleep | Sleep | Time it took the individual to fall asleep | float | s ms min h | s |
| unsaturated_fat | Nutrition | Total unsaturated fat consumed. | float | g | g |
| very_active_duration | Summaries, Workouts | Total duration of very active time as defined by the source. | float | s ms min h | s |
| vo2_max | Summaries | The VO2 Max of the individual as determined by the source. | float | mL/kg/min | mL/kg/min |
| water | Nutrition | Total amount of water consumed as defined by the source. | float | mL fl oz | mL |
| wheelchair_distance | Summaries | The wheelchair distance traveled as defined by the source. | float | m, ft, mi, km, yd | m |
| wheelchair_pushes | Summaries | The number of wheelchair pushes recorded as defined by the source. | integer | count | count |
| workout_duration | Workouts | The duration of the workout event as defined by the device or source. | float | s ms min h | s |
Updated 3 minutes ago