studies

Create a Study

Create an individual, group, or population study examining the relationship between a predictor and outcome variable. You will be given a study id which you can invite participants to join and share their measurements for the specified variables.

post/v3/study/create

Request

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

clientIdstring

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

Request body

causeVariableNamestring required

Name of predictor variable

effectVariableNamestring required

Name of the outcome variable

studyTitlestring

Title of your study (optional)

type'individual' | 'group' | 'global' required

Individual studies are based on data of a single user. Group studies are based on data from a specific group of individuals who have joined. Global studies are based on aggregated and anonymously shared data from all users.

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

No recorded changes to this operation across all 10 revisions of this API.