POST
/
v3
/
study
/
publish
curl --request POST \
  --url https://safe.dfda.earth/api/v3/study/publish \
  --header 'Authorization: Bearer <token>'
{
  "description": "<string>",
  "summary": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "status": "<string>",
  "success": true,
  "code": 123,
  "link": "<string>",
  "card": {
    "actionSheetButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "avatar": "<string>",
    "avatarCircular": "<string>",
    "backgroundColor": "<string>",
    "buttons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "buttonsSecondary": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "content": "<string>",
    "headerTitle": "<string>",
    "html": "<string>",
    "htmlContent": "<string>",
    "id": "<string>",
    "image": "<string>",
    "inputFields": [
      {
        "displayName": "<string>",
        "helpText": "<string>",
        "hint": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "image": "<string>",
        "key": "<string>",
        "labelLeft": "<string>",
        "labelRight": "<string>",
        "link": "<string>",
        "maxLength": 123,
        "maxValue": 123,
        "minLength": 123,
        "minValue": 123,
        "options": [
          "<string>"
        ],
        "placeholder": "<string>",
        "postUrl": "<string>",
        "required": true,
        "show": true,
        "submitButton": {
          "accessibilityText": "<string>",
          "action": {},
          "additionalInformation": "<string>",
          "color": "<string>",
          "confirmationText": "<string>",
          "functionName": "<string>",
          "parameters": {},
          "html": "<string>",
          "id": "<string>",
          "image": "<string>",
          "ionIcon": "<string>",
          "link": "<string>",
          "stateName": "<string>",
          "stateParams": {},
          "successToastText": "<string>",
          "successAlertTitle": "<string>",
          "successAlertBody": "<string>",
          "text": "<string>",
          "tooltip": "<string>",
          "webhookUrl": "<string>"
        },
        "type": "check_box",
        "validationPattern": "<string>",
        "value": "<string>"
      }
    ],
    "ionIcon": "<string>",
    "link": "<string>",
    "parameters": {},
    "selectedButton": {
      "accessibilityText": "<string>",
      "action": {},
      "additionalInformation": "<string>",
      "color": "<string>",
      "confirmationText": "<string>",
      "functionName": "<string>",
      "parameters": {},
      "html": "<string>",
      "id": "<string>",
      "image": "<string>",
      "ionIcon": "<string>",
      "link": "<string>",
      "stateName": "<string>",
      "stateParams": {},
      "successToastText": "<string>",
      "successAlertTitle": "<string>",
      "successAlertBody": "<string>",
      "text": "<string>",
      "tooltip": "<string>",
      "webhookUrl": "<string>"
    },
    "sharingBody": "<string>",
    "sharingButtons": [
      {
        "accessibilityText": "<string>",
        "action": {},
        "additionalInformation": "<string>",
        "color": "<string>",
        "confirmationText": "<string>",
        "functionName": "<string>",
        "parameters": {},
        "html": "<string>",
        "id": "<string>",
        "image": "<string>",
        "ionIcon": "<string>",
        "link": "<string>",
        "stateName": "<string>",
        "stateParams": {},
        "successToastText": "<string>",
        "successAlertTitle": "<string>",
        "successAlertBody": "<string>",
        "text": "<string>",
        "tooltip": "<string>",
        "webhookUrl": "<string>"
      }
    ],
    "sharingTitle": "<string>",
    "subHeader": "<string>",
    "subTitle": "<string>",
    "title": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

clientId
string

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

includeCharts
boolean

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.

recalculate
boolean

Recalculate instead of using cached analysis

studyId
string

Client id for the study you want

Response

201
application/json

Successful operation

The response is of type object.