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

get

https://app.quantimo.do/api/v3/variables

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

Query Params

includeCharts

boolean

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.

numberOfRawMeasurements

string

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

userId

number

User's id

variableCategoryName

string

enum

Ex: Emotions, Treatments, Symptoms...

name

string

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%

variableName

string

Name of the variable you want measurements for

updatedAt

string

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.

sourceName

string

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

earliestMeasurementTime

string

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.

latestMeasurementTime

string

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.

integer

Common variable id

lastSourceName

string

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

limit

integer

Defaults to 100

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

integer

≥ 0

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.

sort

string

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

includePublic

boolean

Include variables the user has no measurements for

manualTracking

boolean

Only include variables tracked manually by the user

clientId

string

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

upc

string

UPC or other barcode scan result

effectOrCause

string

Provided variable is the effect or cause

publicEffectOrCause

string

Ex:

exactMatch

boolean

Require exact match

variableCategoryId

integer

Ex: 13

includePrivate

boolean

Include user-specific variables in results

searchPhrase

string

Ex: %Body Fat%

synonyms

string

Ex: McDonalds hotcake

taggedVariableId

integer

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).

tagVariableId

integer

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).

joinVariableId

integer

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.

parentUserTagVariableId

integer

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.

childUserTagVariableId

integer

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.

ingredientUserTagVariableId

integer

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.

ingredientOfUserTagVariableId

integer

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.

commonOnly

boolean

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

userOnly

boolean

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

includeTags

boolean

Return parent, child, duplicate, and ingredient variables

recalculate

boolean

Recalculate instead of using cached analysis

variableId

integer

Ex: 13

concise

boolean

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

refresh

boolean

Regenerate charts instead of getting from the cache

Responses

401

Not Authenticated

200Variables returned