GET
/
v3
/
studies

Authorizations

Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

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

clientId
string

Your 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
default:
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

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.

Required range: x > 0
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 user_variable_relationships 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

aggregated
boolean

These are aggregated n=1 studies based on the entire population of users that have shared their data

downvoted
boolean

These are studies that you have down-voted

Response

200 - application/json
description
string
required

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

summary
string
required

Can be used as title in help info popup

avatar
string

Square icon png url

html
string

Embeddable list of study summaries with explanation at the top

image
object
ionIcon
string

Ex: ion-ios-person

startTracking
object
studies
object[]