bestStudyLinkstring
Link to study comparing variable with strongest relationship for user or population
bestUserStudyLinkstring
Link to study comparing variable with strongest relationship for user
bestPopulationStudyLinkstring
Link to study comparing variable with strongest relationship for population
optimalValueMessagestring
Description of relationship with variable with strongest relationship for user or population
commonOptimalValueMessagestring
Description of relationship with variable with strongest relationship for population
userOptimalValueMessagestring
Description of relationship with variable with strongest relationship for user
combinationOperation'MEAN' | 'SUM'
The way multiple measurements are aggregated over time
createdAtstring
Ex: 2016-05-18 02:24:08 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
displayNamestring
Ex: Trader Joe's Bedtime Tea
unitAbbreviatedNamestring required
defaultValuenumber float
Default value to use for the measurement when tracking. Unit: User-specified or common.
enabledboolean
If a tracking reminder is enabled, tracking reminder notifications will be generated for this variable.
emailboolean
True if the reminders should be delivered via email
errorMessagestring
Ex: reminderStartTimeLocal is less than $user->earliestReminderTime or greater than $user->latestReminderTime
fillingValueinteger
Ex: 0. Unit: User-specified or common.
firstDailyReminderTimestring
Ex: 02:45:20 in UTC timezone
frequencyTextDescriptionstring
frequencyTextDescriptionWithTimestring
lastTrackedstring
UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the last time a measurement was received for this user and variable
latestTrackingReminderNotificationReminderTimestring
UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the reminder time of the latest tracking reminder notification that has been pre-emptively generated in the database
localDailyReminderNotificationTimesstring[]
localDailyReminderNotificationTimesForAllRemindersstring[]
maximumAllowedValuenumber double
Ex: 5. Unit: User-specified or common.
minimumAllowedValuenumber double
Ex: 1. Unit: User-specified or common.
nextReminderTimeEpochSecondsinteger
notificationBarboolean
True if the reminders should appear in the notification bar
numberOfRawMeasurementsinteger
numberOfUniqueValuesinteger
outcomeboolean
Indicates whether or not the variable is usually an outcome of interest such as a symptom or emotion
pngPathstring
Ex: img/variable_categories/symptoms.png
productUrlstring
Link to associated product for purchase
popUpboolean
True if the reminders should appear as a popup notification
questionstring
Ex: How is your overall mood?
longQuestionstring
Ex: How is your overall mood on a scale of 1 to 5??
reminderEndTimestring
Latest time of day at which reminders should appear in UTC HH:MM:SS format
reminderFrequencyinteger required
Number of seconds between one reminder and the next
reminderSoundstring
String identifier for the sound to accompany the reminder
reminderStartEpochSecondsinteger
reminderStartTimestring
Earliest time of day at which reminders should appear in UTC HH:MM:SS format
reminderStartTimeLocalstring string
reminderStartTimeLocalHumanFormattedstring
secondDailyReminderTimestring
secondToLastValuenumber double
Ex: 1. Unit: User-specified or common.
smsboolean
True if the reminders should be delivered via SMS
startTrackingDatestring string
Earliest date on which the user should be reminded to track in YYYY-MM-DD format
stopTrackingDatestring string
Latest date on which the user should be reminded to track in YYYY-MM-DD format
thirdDailyReminderTimestring
thirdToLastValuenumber double
trackingReminderIdinteger
trackingReminderImageUrlstring
upcstring
UPC or other barcode scan result
updatedAtstring
When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.
userVariableUnitAbbreviatedNamestring
userVariableUnitCategoryIdinteger
userVariableUnitCategoryNamestring
userVariableUnitIdinteger
userVariableUnitNamestring
userVariableVariableCategoryIdinteger
userVariableVariableCategoryNamestring
valencestring
Valence indicates what type of buttons should be used when recording measurements for this variable. positive - Face buttons with the happiest face equating to a 5/5 rating where higher is better like Overall Mood. negative - Face buttons with happiest face equating to a 1/5 rating where lower is better like Headache Severity. numeric - Just 1 to 5 numeric buttons for neutral variables.
valueAndFrequencyTextDescriptionstring
valueAndFrequencyTextDescriptionWithTimestring
Ex: Rate daily at 09:45 PM
variableCategoryIdinteger
variableCategoryImageUrlstring
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' required
Ex: Emotions, Treatments, Symptoms...
variableDescriptionstring
Valence indicates what type of buttons should be used when recording measurements for this variable. positive - Face buttons with the happiest face equating to a 5/5 rating where higher is better like Overall Mood. negative - Face buttons with happiest face equating to a 1/5 rating where lower is better like Headache Severity. numeric - Just 1 to 5 numeric buttons for neutral variables.
variableIdinteger
Id for the variable to be tracked
variableNamestring required
Name of the variable to be used when sending measurements