GET
/
v3
/
correlations

Authorizations

Authorization
string
headerrequired

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

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

clientId
string

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

commonOnly
boolean

Return only public, anonymized and aggregated population data instead of user-specific variables

Response

200 - application/json
description
string
required

Can be used as body of help info popup

summary
string
required

Can be used as title in help info popup

data
object
avatar
string

Square icon png url

errors
object[]

Array of error objects with message property

status
string

ex. OK or ERROR

success
boolean

true or false

code
number

Response code such as 200

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

card
object