v1

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

Get repeating tracking reminder settings

Users can be reminded to track certain variables at a specified frequency with a default value.

get/v3/trackingReminders

Query parameters

userIdnumber

User's id

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

Ex: Emotions, Treatments, Symptoms...

createdAtstring

When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

updatedAtstring

When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

limitinteger

The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.

offsetinteger

OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.

sortstring

Sort by one of the listed field names. If the field name is prefixed with -, it will sort in descending order.

clientIdstring

Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do

appVersionstring

Ex: 2.1.1.0

Response

Successful operation

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

clientIdstring

Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do

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

Ex: /5

unitCategoryIdinteger

Ex: 5

unitCategoryNamestring

Ex: Rating

unitIdinteger

Ex: 10

unitNamestring

Ex: 1 to 5 Rating

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

Ex: Daily

frequencyTextDescriptionWithTimestring

Ex: Daily at 09:45 PM

idinteger

id

inputTypestring

Ex: saddestFaceIsFive

instructionsstring

Ex: I am an instruction!

ionIconstring

Ex: ion-sad-outline

lastTrackedstring

UTC ISO 8601 YYYY-MM-DDThh:mm:ss timestamp for the last time a measurement was received for this user and variable

lastValuenumber double

Ex: 2

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[]
manualTrackingboolean

Ex: 1

maximumAllowedValuenumber double

Ex: 5. Unit: User-specified or common.

minimumAllowedValuenumber double

Ex: 1. Unit: User-specified or common.

nextReminderTimeEpochSecondsinteger

Ex: 1501555520

notificationBarboolean

True if the reminders should appear in the notification bar

numberOfRawMeasurementsinteger

Ex: 445

numberOfUniqueValuesinteger

Ex: 1

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

Ex: 1469760320

reminderStartTimestring

Earliest time of day at which reminders should appear in UTC HH:MM:SS format

reminderStartTimeLocalstring string

Ex: 21:45:20

reminderStartTimeLocalHumanFormattedstring

Ex: 09:45 PM

repeatingboolean

Ex: true

secondDailyReminderTimestring

Ex: 01:00:00

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

Ex: 20:00:00

thirdToLastValuenumber double

Ex: 3

trackingReminderIdinteger

Ex: 11841

trackingReminderImageUrlstring

Ex: Not Found

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.

userIdinteger

ID of User

userVariableUnitAbbreviatedNamestring

Ex: /5

userVariableUnitCategoryIdinteger

Ex: 5

userVariableUnitCategoryNamestring

Ex: Rating

userVariableUnitIdinteger

Ex: 10

userVariableUnitNamestring

Ex: 1 to 5 Rating

userVariableVariableCategoryIdinteger

Ex: 10

userVariableVariableCategoryNamestring

Ex: Symptoms

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

Ex: Rate daily

valueAndFrequencyTextDescriptionWithTimestring

Ex: Rate daily at 09:45 PM

variableCategoryIdinteger

Ex: 10

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