Get user variables
Get user variables settings and statistics. If the user has specified variable settings, these are provided instead of the common variable defaults.
Authorizations
Enter your bearer token in the format Bearer access_token_here
Query Parameters
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.
Filter variables by the total number of measurements that they have. This could be used of you want to filter or sort by popularity.
Ex: Emotions, Treatments, Symptoms...
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
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%
Name of the variable you want measurements for
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.
ID of the source you want measurements for (supports exact name match only)
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.
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.
Common variable id
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
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.
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.
x > 0
Sort by one of the listed field names. If the field name is prefixed with -
, it will sort in descending order.
Include variables the user has no measurements for
Only include variables tracked manually by the user
Your client id can be obtained by creating an app at https://builder.quantimo.do
UPC or other barcode scan result
Provided variable is the effect or cause
Ex:
Require exact match
Ex: 13
Include user-specific variables in results
Ex: %Body Fat%
Ex: McDonalds hotcake
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).
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).
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.
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.
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.
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.
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.
Return only public and aggregated common variable data instead of user-specific variables
Return only user-specific variables and data, excluding common aggregated variable data
Return parent, child, duplicate, and ingredient variables
Recalculate instead of using cached analysis
Ex: 13
Only return field required for variable auto-complete searches. The smaller size allows for storing more variable results locally reducing API requests.
Regenerate charts instead of getting from the cache
Response
User-Defined Variable Setting: Alternative display name
Link to study comparing variable with strongest relationship for user or population
Link to study comparing variable with strongest relationship for user
Link to study comparing variable with strongest relationship for population
Description of relationship with variable with strongest relationship for user or population
Description of relationship with variable with strongest relationship for population
Description of relationship with variable with strongest relationship for user
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
An object with various chart properties each property contain and svg and Highcharts configuration
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%2Fapi.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png
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%252Fapi.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%0A%0AHave%20a%20great%20day!
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%252Fapi.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png
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%252Fapi.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png
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%2Fapi.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png
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%252Fapi.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%20%40curedao
Commonly defined for all users. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
User-Defined Variable Setting: An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
Your client id can be obtained by creating an app at https://builder.quantimo.do
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.
MEAN
, SUM
Ex: Anxiety / Nervousness
Commonly defined for all users. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
Commonly defined for all users. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Comma-separated list of source names to limit variables to those sources
These are sources of measurements for this variable
User-Defined Variable Setting: Ex: Summary to be used in studies.
Ex: Trader Joe's Bedtime Tea
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
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
Earliest filling time
Earliest measurement time
Earliest source time
Error message from last analysis
User-Defined Variable Setting: Latest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss.
User-Defined Variable Setting: Earliest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss.
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.
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. Unit: User-specified or common.
Ex: ion-sad-outline
Ex: 95614
Ex: https://google.com
Commonly defined for all users. IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredient of the variable Lollipop could be Sugar. This way you only have to record Lollipop consumption, and we can use this data to see how sugar might be affecting you.
Commonly defined for all users. IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredient of the variable Lollipop could be Sugar. This way you only have to record Lollipop consumption, and we can use this data to see how sugar might be affecting you.
User-Defined Variable Setting: IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredient of the variable Lollipop could be Sugar. This way you only have to record Lollipop consumption, and we can use this data to see how sugar might be affecting you.
User-Defined Variable Setting: IngredientOf variable measurements will be included in analysis of the ingredient variable. For instance, a ingredient of the variable Lollipop could be Sugar. This way you only have to record Lollipop consumption, and we can use this data to see how sugar might be affecting you.
Type of input field to show for recording measurements
Commonly defined for all users. Joining can be used used to merge duplicate variables. For instance, if two variables called Apples (Red Delicious) and Red Delicious Apples are joined, when one of them is analyzed, the measurements for the other will be included as well.
User-Defined Variable Setting: Joining can be used used to merge duplicate variables. For instance, if two variables called Apples (Red Delicious) and Red Delicious Apples are joined, when one of them is analyzed, the measurements for the other will be included as well.
Duplicate variables. If the variable is joined with some other variable then it is not shown to user in the list of variables
Kurtosis
Calculated Statistic: Ex: 500. Unit: User-specified or common.
When this variable or its settings were last updated UTC ISO 8601 YYYY-MM-DDThh:mm:ss
Calculated Statistic: Last measurement value in the common unit or user unit if different. Unit: User-specified or common.
Latest filling time
Latest measurement time. Format: Unix-time epoch seconds.
Latest source time. Format: Unix-time epoch seconds.
Ex: 1501383600. Format: Unix-time epoch seconds.
Latitude. Unit: User-specified or common.
Location
Longitude
True if the variable is an emotion or symptom rating that is not typically automatically collected by a device or app.
User-Defined Variable Setting: The maximum allowed value a daily aggregated measurement. Unit: User-specified or common.
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.
Calculated Statistic: Maximum recorded daily value of this variable. Unit: User-specified or common.
Calculated Statistic: Ex: 1. Unit: User-specified or common.
Mean. Unit: User-specified or common.
Number of measurements at last analysis
Median
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
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.
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.
Minimum recorded value of this variable. Unit: User-specified or common.
Ex: 51
Ex: 23
Most common Unit ID
Calculated Statistic: Most common value. Unit: User-specified or common.
Ex: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)
Ex: 1
Ex: 310
Number of changes
Number of user_variable_relationships for this variable
numberOfGlobalVariableRelationshipsAsCause plus numberOfUserVariableRelationshipsAsCause
numberOfGlobalVariableRelationshipsAsEffect plus numberOfUserVariableRelationshipsAsEffect
Number of processed measurements
Ex: 295
Ex: 1
Number of unique daily values
Ex: 2
Ex: 115
Ex: 29014
Ex: 2
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.
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.
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
Do you want to receive updates on newly discovered factors influencing this variable?
Commonly defined for all users. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
User-defined. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
Ex: img/variable_categories/treatments.png
Ex: https://safe.dfda.earth/img/variable_categories/treatments.png
Ex: 0
Ex: 95.4
Link to associated product for purchase
Should this variable show up in automcomplete searches for users who do not already have measurements for it?
Ex: How is your overall mood?
Ex: How is your overall mood on a scale of 1 to 5??
Ex: 131
Calculated Statistic: Ex: 1. Unit: User-specified or common.
Calculated Statistic: Ex: 250. Unit: User-specified or common.
Would you like to make your measurements publicly visible?
Skewness
Standard deviation Ex: 0.46483219855434
status
Based on sort filter and can be shown beneath variable name on search list
Ex: https://safe.dfda.earth/img/variable_categories/treatments.svg
Calculated Statistic: Ex: 6. Unit: User-specified or common.
Calculated Statistic: Ex: 250. Unit: User-specified or common.
HTML instructions for tracking
Ex: count
Ex: 6
Ex: Miscellany
ID of unit to use for this variable
User-Defined Variable Setting: Count
Universal product code or similar
updated
When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format
Ex: 2017-07-30 14:58:26
User ID
User-defined. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
User-defined. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple. Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed. This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.
Ex: count
Ex: 6
Ex: Miscellany
Ex: 23
Ex: 95614
Ex: Count
Array of Variables that are joined with this Variable. These are basically duplicate variables.
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 the 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.
Ex: 6
User-Defined Variable Setting: Variable category like Emotions, Sleep, Physical Activities, Treatments, Symptoms, etc.
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: 96380
Ex: Sleep Duration
Statistic: Ex: 115947037.40816
User-Defined Variable Setting: You can help to improve the studies by pasting the title of the most appropriate Wikipedia article for this variable