POST
/
v3
/
study
/
create

Authorizations

Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

clientId
string

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

Body

application/json
causeVariableName
string
required

Name of predictor variable

effectVariableName
string
required

Name of the outcome variable

type
enum<string>
required

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.

Available options:
individual,
group,
global
studyTitle
string

Title of your study (optional)

Response

201 - application/json
card
object
code
number

Response code such as 200

description
string

Can be used as body of help info popup

errors
object[]

Array of error objects with message property

A super neat url you might want to share with your users!

status
string

ex. OK or ERROR

study
object

A study analyzes the relationship between a predictor variable like gluten-intake and an outcome of interest such as overall mood.