Validic Objects

 

Using Validic Objects

Each object being sent to Validic Connect has requirements. Below you can review the requirements and what fields we are expecting to receive from your application.  This will allow you to structure POST requests accordingly.

If you need assistance with mapping your data attributes to Validic’s please email us at product-support@validic.com.  We provide support to help make sure your data is mapped appropriately and we communicate the mapping structure to customers who will be consuming your data.  If you are having trouble finding a standard endpoint or attribute that makes sense to map to, you can always choose to add custom attributes as “extras” to any of our standard objects.  See our section below for additional information for “handling custom data”.

Fitness

Field	Description	Type	Validation
timestamp	Fitness activity timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
type	Type of fitness activity: Walking, Running, Swimming, etc.	String
intensity	Subjective intensity with which an activity was performed. Examples are: low, medium, high. Returned as provided by source	String
start_time	Timestamp of when fitness activity started in ISO08601 format	String
distance	Distance in meters	Double
duration	Duration of fitness activity in seconds	Double
calories	The value of the measured quantity in kilocalories (Calories)	Double
activity_id	Fitness activity record id in your database	String	Must be unique

Routine

Routine records represent data that is aggregated and updated throughout the day. For example, a running total of steps taken during a day.  If you wish to push routine data to Validic, your system should POST a new record for the initial reading and update the same routine record using a PUT for subsequent changes. Moreover, whereas a typical activity_id would represent your record’s unique identifier, your routine activity_id should represent the date. This is because a single routine record in Validic will oftentimes represent an aggregate of several of your records.

Timestamps in Routine: Timestamps for routine objects should represent midnight after adding the utc_offset. For example, if the offset is “-05:00” and the routine record represents a running total for 2014-12-25, then the timestamp should be “2014-12-25T05:00:00+00:00”.

Field	Description	Type	Validation
timestamp	See note above	String	Required
utc_offset	See note above	String
steps	Number of steps taken throughout the day	Double
distance	Distance in meters	Double
floors	The number of floors taken throughout the day	Double
elevation	Elevation climbed in meters throughout the day	Double
calories_burned	The value of the measured quantity in kilocalories (Calories)	Double
stairs_climbed	Stairs climbed throughout the day	Double
activity_id	Routine record id in your database	String	Must be unique

Sleep

Field	Description	Type	Validation
timestamp	Sleep activity timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
awake	Seconds awake during recording	Double
deep	Seconds in deep sleep	Double
light	Seconds in light sleep	Double
rem	Seconds in rapid eye movement	Double
times_woken	Number of times woken during sleep recording	Double
total_sleep	Total number of sleep seconds	Double
activity_id	sleep record id in your database	String	Must be unique

Weight

Field	Description	Type	Validation
timestamp	Weight activity timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
weight	The value of the measured quantity in kg	Double
height	The value of the measured quantity in cm	Double
free_mass	The value of the measured quantity in kg	Double
fat_percent	The value of the measured quantity as a 0 – 100 percentage (%)	Double
mass_weight	The value of the measured quantity in kg	Double
bmi	The value of the measured quantity	Double
activity_id	Unique identifier of the measurement (required for POST requests)	String	Must be unique

Tobacco Cessation

Field	Description	Type	Validation
timestamp	Record timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
cigarettes_allowed	Number of cigarettes permissable to smoke in a day	Double
cigarettes_smoked	Number of cigarettes smoked that day	Double
cravings	Number of times user felt a craving for a cigarette	Double
last_smoked	Last time user smoked a cigarette in ISO8601	String
activity_id	Tobacco cessation entry record id in your database	String	Must be unique

Nutrition

Field	Description	Type	Validation
timestamp	Record timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
calories	The value of the measured quantity in kilocalories (Calories)	Double
carbohydrates	Grams of carbohydrates consumed	Double
fat	Grams of fat consumed	Double
fiber	Grams of fiber consumed	Double
protein	Grams of protein consumed	Double
sodium	Grams of sodium consumed	Double
water	Grams of water consumed	Double
meal	Meal consumed: Breakfast, Lunch, or Dinner	String
activity_id	Record of meal entry in your database	String	Must be unique

Biometrics

Field	Description	Type	Validation
timestamp	Record timestamp in ISO8601 format	Double	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
blood_calcium	The value of the measured quantity in mg/dL	Double
blood_chromium	The value of the measured quantity in µg/L	Double
blood_folic_acid	The value of the measured quantity in ng/mL	Double
blood_magnesium	The value of the measured quantity in mg/dL	Double
blood_potassium	The value of the measured quantity in mEq/L	Double
blood_sodium	The value of the measured quantity in mEq/L	Double
blood_vitamin_b12	The value of the measured quantity in pg/mL	Double
blood_zinc	The value of the measured quantity in µg/dL	Double
creatine_kinase	The value of the measured quantity in U/L	Double
crp	The value of the measured quantity in mg/L	Double
diastolic	The value of the measured quantity in mmHg	Double
ferritin	The value of the measured quantity in ng/mL	Double
hdl	The value of the measured quantity in mg/dL	Double
hscrp	The value of the measured quantity in mg/L	Double
il6	The value of the measured quantity in pg/mL	Double
ldl	The value of the measured quantity in mg/dL	Double
resting_heartrate	The value of the measured quantity in bpm	Double
systolic	The value of the measured quantity in mmHg	Double
testosterone	The value of the measured quantity in ng/dL	Double
total_cholesterol	The value of the measured quantity in mg/dL	Double
tsh	The value of the measured quantity in mIU/L	Double
uric_acid	The value of the measured quantity in mg/dL	Double
vitamin_d	The value of the measured quantity in ng/mL	Double
white_cell_count	The value of the measured quantity in cells/µL	Double
spo2	The value of the measured quantity as a 0 – 100 percentage (%)	Double
temperature	The value of the measured quantity in Celsius	Double
activity_id	Unique identifier of the measurement in your system	Double	Must be unique

Diabetes

Field	Description	Type	Validation
timestamp	Record timestamp in ISO8601 format	String	Required
utc_offset	Timezone information for the measurement set with the following format: “+00:00”	String
c_peptide	The value of the measured quantity in ng/mL	Double
fasting_plasma_glucose_test	The value of the measured quantity in mg/dL	Double
hba1c	The value of the measured quantity in %	Double
insulin	The value of the measured quantity in U	Double
oral_glucose_tolerance_test	The value of the measured quantity in mg/dL	Double
random_plasma_glucose_test	The value of the measured quantity in mg/dL	Double
triglyceride	The value of the measured quantity in mg/dL	Double
blood_glucose	The value of the measured quantity in mg/dL	Double
activity_id	Diabetes record id in your database	String	Must be unique

View More >