API Reference
- Getting Started
- Variables
- Measurements
- Analytics
- App Settings
- Data Import
- Feed
- Notifications
- Reminders
- Shares
- Studies
- Units
- User
Create a Study
Create an individual, group, or population study examining the relationship between a predictor and outcome variable. You will be given a study id which you can invite participants to join and share their measurements for the specified variables.
Authorizations
Enter your bearer token in the format Bearer access_token_here
Query Parameters
Your client id can be obtained by creating an app at https://builder.quantimo.do
Body
Name of predictor variable
Name of the outcome variable
Individual studies are based on data of a single user. Group studies are based on data from a specific group of individuals who have joined. Global studies are based on aggregated and anonymously shared data from all users.
individual
, group
, global
Title of your study (optional)
Response
HTML element id
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box
, date
, email
, number
, postal_code
, select_option
, string
, switch
, text_area
, unit
, variable_category
HTML element id
Selector list options
Ex: Title
Ex: Title
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title
Response code such as 200
Can be used as body of help info popup
Array of error objects with message property
Error message
A super neat url you might want to share with your users!
ex. OK or ERROR
A study analyzes the relationship between a predictor variable like gluten-intake and an outcome of interest such as overall mood.
Ex: population, cohort, or individual
Ex: 95614
Ex: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)
User ID
Ex: 96380
Ex: track
Ex: trackThreeRatingAction
Ex: 3
Ex: 3/5
Ex: Rate 3/5
Ex: 3
User-Defined Variable Setting: Alternative display name
Unit abbreviation
Unit category
Distance
, Duration
, Energy
, Frequency
, Miscellany
, Pressure
, Proportion
, Rating
, Temperature
, Volume
, Weight
, Count
Ex: 4
Unit name
Ex: 1
Ex: 6
Ex: Miscellany
Ex: 29
Ex: https://static.quantimo.do/img/medical/png/pill.png
Ex: 0
The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis.
The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis.
Ex: 0
HTML element id
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box
, date
, email
, number
, postal_code
, select_option
, string
, switch
, text_area
, unit
, variable_category
HTML element id
Selector list options
Ex: Title
Ex: Title
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingTitle
Ex: subTitle
Ex: subTitle
Ex: Title
Link to study comparing variable with strongest relationship for population
HTML element id
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Smaller square image
Smaller circular image
Ex: #f2f2f2
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: Content
Ex: Title
HTML for the entire card.
Ex: <div>Content</div>
Larger image of variable dimensions
Ex: Title
check_box
, date
, email
, number
, postal_code
, select_option
, string
, switch
, text_area
, unit
, variable_category
HTML element id
Selector list options
Ex: Title
Ex: Title
See https://html5pattern.com/ for examples
Ex: ion-refresh
A link to a web page or something. Not much more to say about that.
Key value pairs derived from user input fields, button clicks, or preset defaults
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect
HTML element id
Ex: https://image.jpg
Ex: ion-refresh
Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
State to go to
Data to provide to the state
Text to show user after executing functionName
Text to show user after executing functionName
Text to show user after executing functionName
Ex: This is a tooltip
Post here on button click
Ex: sharingBody
Ex: https://local.quantimo.do
Ex: Connect
Ex: connect
Action data
Ex: connect
Ex: #f2f2f2
Text to show user before executing functionName
Name of function to call
Ex: connect