Sign in

v1

latestOpenAPI 3.0.1GNU General Public License v3 (GPL-3)2026-07-145265194.5 KB
measurements

Post a new set or update existing measurements to the database

You can submit or update multiple measurements in a "measurements" sub-array. If the variable these measurements correspond to does not already exist in the database, it will be automatically added.

post/v3/measurements/post

Query parameters

userIdnumber

User's id

Request body

combinationOperation'MEAN' | 'SUM'

Way to aggregate measurements over time. SUM should be used for things like minutes of exercise. If you use MEAN for exercise, then a person might exercise more minutes in one day but add separate measurements that were smaller. So when we are doing correlational analysis, we would think that the person exercised less that day even though they exercised more. Conversely, we must use MEAN for things such as ratings which cannot be SUMMED.

sourceNamestring required

Name of the application or device used to record the measurement values

unitAbbreviatedNamestring required

Unit of measurement

variableCategoryName'Activity' | 'Books' | 'Causes of Illness' | 'Cognitive Performance' | 'Conditions' | 'Emotions' | 'Environment' | 'Foods' | 'Goals' | 'Locations' | 'Miscellaneous' | 'Movies and TV' | 'Music' | 'Nutrients' | 'Payments' | 'Physical Activities' | 'Physique' | 'Sleep' | 'Social Interactions' | 'Software' | 'Symptoms' | 'Treatments' | 'Vital Signs'

Ex: Emotions, Treatments, Symptoms...

variableNamestring required

ORIGINAL name of the variable for which we are creating the measurement records

upcstring

UPC or other barcode scan result

Response

Successful operation

messagestring

Message

descriptionstring

Can be used as body of help info popup

summarystring

Can be used as title in help info popup

statusstring required

ex. OK or ERROR

successboolean required

true or false

codenumber

Response code such as 200

linkstring

A super neat url you might want to share with your users!