analytics

Get correlations

Changed on

Get a list of correlations that can be used to display top predictors of a given outcome like mood, for instance.

get/v3/correlations

Request

  • Base URL: https://api.curedao.org/api
  • URL: https://api.curedao.org/api/v3/correlations
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.curedao.org/api/v1/oauth/authorize, token URL https://api.curedao.org/api/v1/oauth/token, scopes: basic)

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

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.curedao.org

commonOnlyboolean

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

Response

Successful operation

descriptionstring required

Can be used as body of help info popup

summarystring required

Can be used as title in help info popup

avatarstring

Square icon png url

statusstring

ex. OK or ERROR

successboolean

true or false

codenumber

Response code such as 200

linkstring

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

Changes

    • warning

      deleted the query request parameter causeVariableId

    • warning

      deleted the query request parameter effectVariableId

    • warning

      deleted the query request parameter outcomeVariableName

    • warning

      deleted the query request parameter predictorVariableName