Sign in
studies

Publish Your Study

Changed on

Make a study and all related measurements publicly visible by anyone

post/v3/study/publish

Request

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

descriptionstring

Can be used as body of help info popup

summarystring

Can be used as title in help info popup

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

  • 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