v1

latestOpenAPI 3.0.1GNU General Public License v3 (GPL-3)2026-07-145265194.5 KB
studies

Get Personal or Population Studies

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

get/v3/studies

Query parameters

causeVariableNamestring

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

effectVariableNamestring

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

causeVariableIdinteger

Variable id of the hypothetical predictor variable. Ex: 1398

effectVariableIdinteger

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

predictorVariableNamestring

Name of the hypothetical predictor variable. Ex: Sleep Duration

outcomeVariableNamestring

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

userIdnumber

User's id

clientIdstring

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

includeChartsboolean

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.

recalculateboolean

Recalculate instead of using cached analysis

studyIdstring

Client id for the study you want

sortstring

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

limitinteger

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.

offsetinteger

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.

correlationCoefficientstring

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

updatedAtstring

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.

outcomesOfInterestboolean

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

principalInvestigatorUserIdinteger

These are studies created by a specific principal investigator

openboolean

These are studies that anyone can join

joinedboolean

These are studies that you have joined

createdboolean

These are studies that you have created

populationboolean

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

downvotedboolean

These are studies that you have down-voted

Response

Successful operation

descriptionstring required

Ex: These factors are most predictive of Overall Mood based on your own data.

summarystring required

Can be used as title in help info popup

avatarstring

Square icon png url

ionIconstring

Ex: ion-ios-person

titlestring

Ex: Top Predictors of Overall Mood

htmlstring

Embeddable list of study summaries with explanation at the top