Get Personal or Population Studies

get https://app.quantimo.do/api/v3/studies

If you have enough data, this will be a list of your personal studies, otherwise it will consist of aggregated population studies.

Query Params

causeVariableName

string

Deprecated: Name of the hypothetical predictor variable. Ex: Sleep Duration

effectVariableName

string

Deprecated: Name of the outcome variable of interest. Ex: Overall Mood

causeVariableId

integer

Variable id of the hypothetical predictor variable. Ex: 1398

effectVariableId

integer

Variable id of the outcome variable of interest. Ex: 1398

predictorVariableName

string

Name of the hypothetical predictor variable. Ex: Sleep Duration

outcomeVariableName

string

Name of the outcome variable of interest. Ex: Overall Mood

userId

number

User's id

clientId

string

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

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.

recalculate

boolean

Recalculate instead of using cached analysis

studyId

string

Client id for the study you want

sort

string

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

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.

correlationCoefficient

string

Pearson correlation coefficient between cause and effect after lagging by onset delay and grouping by duration of action

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.

outcomesOfInterest

boolean

Only include correlations for which the effect is an outcome of interest for the user

principalInvestigatorUserId

integer

These are studies created by a specific principal investigator

open

boolean

These are studies that anyone can join

joined

boolean

These are studies that you have joined

created

boolean

These are studies that you have created

population

boolean

These are studies based on the entire population of users that have shared their data

downvoted

boolean

These are studies that you have down-voted

Responses

404

Not found

500

Internal server error

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://app.quantimo.do/api/v3/studies?limit=100' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here!

200Successful operation

401Successful operation