v1

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

variables

Get variables along with related user-specific analysis settings and statistics

Get variables. If the user has specified variable settings, these are provided instead of the common variable defaults.

get/v3/variables

Query parameters

includeChartsboolean

Highcharts configs that can be used if you have highcharts.js included on the page. This only works if the id or name query parameter is also provided.

numberOfRawMeasurementsstring

Filter variables by the total number of measurements that they have. This could be used of you want to filter or sort by popularity.

userIdnumber

User's id

Ex: Emotions, Treatments, Symptoms...

namestring

Name of the variable. To get results matching a substring, add % as a wildcard as the first and/or last character of a query string parameter. In order to get variables that contain Mood, the following query should be used: ?variableName=%Mood%

variableNamestring

Name of the variable you want measurements for

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.

sourceNamestring

ID of the source you want measurements for (supports exact name match only)

earliestMeasurementTimestring

Excluded records with measurement times earlier than this value. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

latestMeasurementTimestring

Excluded records with measurement times later than this value. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

idinteger

Common variable id

lastSourceNamestring

Limit variables to those which measurements were last submitted by a specific source. So if you have a client application and you only want variables that were last updated by your app, you can include the name of your app here

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.

includePublicboolean

Include variables the user has no measurements for

manualTrackingboolean

Only include variables tracked manually by the user

clientIdstring

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

upcstring

UPC or other barcode scan result

effectOrCausestring

Provided variable is the effect or cause

publicEffectOrCausestring

Ex:

exactMatchboolean

Require exact match

variableCategoryIdinteger

Ex: 13

includePrivateboolean

Include user-specific variables in results

searchPhrasestring

Ex: %Body Fat%

synonymsstring

Ex: McDonalds hotcake

taggedVariableIdinteger

Id of the tagged variable (i.e. Lollipop) you would like to get variables it can be tagged with (i.e. Sugar). Converted measurements of the tagged variable are included in analysis of the tag variable (i.e. ingredient).

tagVariableIdinteger

Id of the tag variable (i.e. Sugar) you would like to get variables it can be tagged to (i.e. Lollipop). Converted measurements of the tagged variable are included in analysis of the tag variable (i.e. ingredient).

joinVariableIdinteger

Id of the variable you would like to get variables that can be joined to. This is used to merge duplicate variables. If joinVariableId is specified, this returns only variables eligible to be joined to the variable specified by the joinVariableId.

parentUserTagVariableIdinteger

Id of the parent category variable (i.e. Fruit) you would like to get eligible child sub-type variables (i.e. Apple) for. Child variable measurements will be included in analysis of the parent variable. For instance, a child sub-type of the parent category Fruit could be Apple. When Apple is tagged with the parent category Fruit, Apple measurements will be included when Fruit is analyzed.

childUserTagVariableIdinteger

Id of the child sub-type variable (i.e. Apple) you would like to get eligible parent variables (i.e. Fruit) for. Child variable measurements will be included in analysis of the parent variable. For instance, a child sub-type of the parent category Fruit could be Apple. When Apple is tagged with the parent category Fruit, Apple measurements will be included when Fruit is analyzed.

ingredientUserTagVariableIdinteger

Id of the ingredient variable (i.e. Fructose) you would like to get eligible ingredientOf variables (i.e. Apple) for. IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredientOf of variable Fruit could be Apple.

ingredientOfUserTagVariableIdinteger

Id of the ingredientOf variable (i.e. Apple) you would like to get eligible ingredient variables (i.e. Fructose) for. IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredientOf of variable Fruit could be Apple.

commonOnlyboolean

Return only public and aggregated common variable data instead of user-specific variables

userOnlyboolean

Return only user-specific variables and data, excluding common aggregated variable data

includeTagsboolean

Return parent, child, duplicate, and ingredient variables

recalculateboolean

Recalculate instead of using cached analysis

variableIdinteger

Ex: 13

conciseboolean

Only return field required for variable auto-complete searches. The smaller size allows for storing more variable results locally reducing API requests.

refreshboolean

Regenerate charts instead of getting from the cache

Response

Variables returned

aliasstring

User-Defined Variable Setting: Alternative display name

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

causeOnlyboolean

User-Defined Variable Setting: True indicates that this variable is generally a cause in a causal relationship. An example of a causeOnly variable would be a variable such as Cloud Cover which would generally not be influenced by the behaviour of the user

chartsLinkDynamicstring

Ex: https://local.quantimo.do/ionic/Modo/www/#/app/charts/Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29?variableName=Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png

chartsLinkEmailstring

Ex: mailto:?subject=Check%20out%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20data%21&body=See%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20history%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%0A%0AHave%20a%20great%20day!

chartsLinkFacebookstring

Ex: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png

chartsLinkGooglestring

Ex: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png

chartsLinkStaticstring

Ex: https://local.quantimo.do/api/v2/charts?variableName=Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png

chartsLinkTwitterstring

Ex: https://twitter.com/home?status=Check%20out%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20data%21%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%20%40curedao

clientIdstring

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

combinationOperation'MEAN' | 'SUM'

User-Defined Variable Setting: How 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.

commonAliasstring

Ex: Anxiety / Nervousness

createdAtstring

When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format

dataSourceNamesstring

Comma-separated list of source names to limit variables to those sources

descriptionstring

User-Defined Variable Setting: Ex: Summary to be used in studies.

displayNamestring

Ex: Trader Joe's Bedtime Tea

durationOfActioninteger

The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. Unit: Seconds

durationOfActionInHoursnumber float

User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. Unit: Hours

earliestFillingTimeinteger

Earliest filling time

earliestMeasurementTimeinteger

Earliest measurement time

earliestSourceTimeinteger

Earliest source time

errorMessagestring

Error message from last analysis

experimentEndTimestring

User-Defined Variable Setting: Latest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss.

experimentStartTimestring

User-Defined Variable Setting: Earliest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss.

fillingType'none' | 'zero-filling' | 'value-filling'

User-Defined Variable Setting: When it comes to analysis to determine the effects of this variable, knowing when it did not occur is as important as knowing when it did occur. For example, if you are tracking a medication, it is important to know when you did not take it, but you do not have to log zero values for all the days when you haven't taken it. Hence, you can specify a filling value (typically 0) to insert whenever data is missing.

fillingValuenumber float

iconIconstring

Ex: ion-sad-outline

idinteger required

Ex: 95614

imageUrlstring

informationalUrlstring

Ex: https://google.com

inputTypestring

Type of input field to show for recording measurements

ionIconstring

joinWithinteger

Duplicate variables. If the variable is joined with some other variable then it is not shown to user in the list of variables

kurtosisnumber float

Kurtosis

lastProcessedDailyValuenumber double

Calculated Statistic: Ex: 500. Unit: User-specified or common.

lastSuccessfulUpdateTimestring

When this variable or its settings were last updated UTC ISO 8601 YYYY-MM-DDThh:mm:ss

lastValuenumber float

Calculated Statistic: Last measurement value in the common unit or user unit if different. Unit: User-specified or common.

latestFillingTimeinteger

Latest filling time

latestMeasurementTimeinteger

Latest measurement time. Format: Unix-time epoch seconds.

latestSourceTimeinteger

Latest source time. Format: Unix-time epoch seconds.

latestUserMeasurementTimeinteger

Ex: 1501383600. Format: Unix-time epoch seconds.

latitudenumber float

Latitude. Unit: User-specified or common.

locationstring

Location

longitudenumber float

Longitude

manualTrackingboolean

True if the variable is an emotion or symptom rating that is not typically automatically collected by a device or app.

maximumAllowedDailyValuenumber float

User-Defined Variable Setting: The maximum allowed value a daily aggregated measurement. Unit: User-specified or common.

maximumAllowedValuenumber float

User-Defined Variable Setting: The maximum allowed value a single measurement. While you can record a value above this maximum, it will be excluded from the correlation analysis. Unit: User-specified or common.

maximumRecordedDailyValuenumber float

Calculated Statistic: Maximum recorded daily value of this variable. Unit: User-specified or common.

maximumRecordedValuenumber double

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

meannumber float

Mean. Unit: User-specified or common.

measurementsAtLastAnalysisinteger

Number of measurements at last analysis

mediannumber float

Median

minimumAllowedValuenumber float

User-Defined Variable Setting: The minimum allowed value a single measurement. While you can record a value below this minimum, it will be excluded from the correlation analysis. Unit: User-specified or common

minimumAllowedDailyValuenumber float

User-Defined Variable Setting: The minimum allowed value a daily aggregated measurement. For instance, you might set to 100 for steps to keep erroneous 0 daily steps out of the analysis. Unit: User-specified or common.

minimumNonZeroValuenumber float

User-Defined Variable Setting: The minimum allowed non-zero value a single measurement. For instance, you might set to 100 mL for steps to keep erroneous 0 daily steps out of the analysis. Unit: User-specified or common.

minimumRecordedValuenumber float

Minimum recorded value of this variable. Unit: User-specified or common.

mostCommonConnectorIdinteger

Ex: 51

mostCommonOriginalUnitIdinteger

Ex: 23

mostCommonUnitIdinteger

Most common Unit ID

mostCommonValuenumber float

Calculated Statistic: Most common value. Unit: User-specified or common.

namestring required

Ex: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)

numberOfAggregateCorrelationsAsCauseinteger

Ex: 1

numberOfAggregateCorrelationsAsEffectinteger

Ex: 310

numberOfChangesinteger

Number of changes

numberOfCorrelationsinteger

Number of correlations for this variable

numberOfCorrelationsAsCauseinteger

numberOfAggregateCorrelationsAsCause plus numberOfUserCorrelationsAsCause

numberOfCorrelationsAsEffectinteger

numberOfAggregateCorrelationsAsEffect plus numberOfUserCorrelationsAsEffect

numberOfProcessedDailyMeasurementsinteger

Number of processed measurements

numberOfRawMeasurementsinteger

Ex: 295

numberOfTrackingRemindersinteger

Ex: 1

numberOfUniqueDailyValuesnumber float

Number of unique daily values

numberOfUniqueValuesinteger

Ex: 2

numberOfUserCorrelationsAsCauseinteger

Ex: 115

numberOfUserCorrelationsAsEffectinteger

Ex: 29014

numberOfUserVariablesinteger

Ex: 2

onsetDelayinteger

The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes.

onsetDelayInHoursnumber double

User-Defined Variable Setting: The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes.

outcomeboolean

User-Defined Variable Setting: True for variables for which a human would generally want to identify the influencing factors. These include symptoms of illness, physique, mood, cognitive performance, etc. Generally correlation calculations are only performed on outcome variables

outcomeOfInterestboolean

Do you want to receive updates on newly discovered factors influencing this variable?

pngPathstring

Ex: img/variable_categories/treatments.png

pngUrlstring

Ex: https://web.quantimo.do/img/variable_categories/treatments.png

predictorOfInterestinteger

Ex: 0

pricenumber double

Ex: 95.4

productUrlstring

Link to associated product for purchase

publicboolean

Should this variable show up in automcomplete searches for users who do not already have measurements for it?

questionstring

Ex: How is your overall mood?

longQuestionstring

Ex: How is your overall mood on a scale of 1 to 5??

rawMeasurementsAtLastAnalysisinteger

Ex: 131

secondMostCommonValuenumber double

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

secondToLastValuenumber double

Calculated Statistic: Ex: 250. Unit: User-specified or common.

shareUserMeasurementsboolean

Would you like to make your measurements publicly visible?

skewnessnumber float

Skewness

standardDeviationnumber double

Standard deviation Ex: 0.46483219855434

statusstring

status

subtitlestring

Based on sort filter and can be shown beneath variable name on search list

svgUrlstring

Ex: https://web.quantimo.do/img/variable_categories/treatments.svg

thirdMostCommonValuenumber double

Calculated Statistic: Ex: 6. Unit: User-specified or common.

thirdToLastValuenumber double

Calculated Statistic: Ex: 250. Unit: User-specified or common.

trackingInstructionsstring

HTML instructions for tracking

unitAbbreviatedNamestring

Ex: count

unitCategoryIdinteger

Ex: 6

unitCategoryNamestring

Ex: Miscellany

unitIdinteger

ID of unit to use for this variable

unitNamestring

User-Defined Variable Setting: Count

upcstring

Universal product code or similar

updatedinteger

updated

updatedAtstring

When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format

updatedTimestring

Ex: 2017-07-30 14:58:26

userIdinteger required

User ID

userVariableUnitAbbreviatedNamestring

Ex: count

userVariableUnitCategoryIdinteger

Ex: 6

userVariableUnitCategoryNamestring

Ex: Miscellany

userVariableUnitIdinteger

Ex: 23

userVariableUnitNamestring

Ex: Count

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.

variableCategoryIdinteger

Ex: 6

User-Defined Variable Setting: Variable category like Emotions, Sleep, Physical Activities, Treatments, Symptoms, etc.

variableIdinteger required

Ex: 96380

variableNamestring

Ex: Sleep Duration

variancenumber double

Statistic: Ex: 115947037.40816

wikipediaTitlestring

User-Defined Variable Setting: You can help to improve the studies by pasting the title of the most appropriate Wikipedia article for this variable