Sign in
studies

Get Study

Changed on

Get Study

get/v4/study

Request

  • Base URL: https://api.curedao.org/api
  • URL: https://api.curedao.org/api/v4/study
  • 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

userIdnumber

User's id

clientIdstring

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

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

Response

Successful operation

typestring required

Ex: population, cohort, or individual

userIdinteger

The user id of the principal investigator or subject if an individual studies

idstring

ID of the cohort study which is necessary to allow participants to join

causeVariableNamestring

Ex: Sleep Quality

effectVariableNamestring

Ex: Overall Mood

joinedboolean

True if you are sharing your data with this study

Changes

  • v3670117250514Revision 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