v1

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

Studies You Have Joined

These are studies that you are currently sharing your data with.

get/v3/studies/joined

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

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.

userIdnumber

User's id

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

clientIdstring

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

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