---
agentTools:
  projectIndex: https://curedao.readme.io/llms.txt
---

# Get Study

Get Study

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "CureDAO Unified Health API",
    "description": "A platform for participant-centered research and personal data exploration",
    "termsOfService": "https://quantimo.do/tos",
    "contact": {
      "name": "hello@curedao.org"
    },
    "license": {
      "name": "GNU General Public License v3 (GPL-3)",
      "url": "https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)"
    },
    "version": "0.0.1"
  },
  "servers": [
    {
      "url": "https://app.quantimo.do/api"
    }
  ],
  "tags": [
    {
      "name": "studies",
      "description": "Automatically generated natural language studies examining the relationship between a predictor and outcome variable including charts.",
      "externalDocs": {
        "description": "Search for a study",
        "url": "https://web.quantimo.do/#/app/studies"
      }
    }
  ],
  "paths": {
    "/v4/study": {
      "get": {
        "tags": [
          "studies"
        ],
        "summary": "Get Study",
        "description": "Get Study",
        "operationId": "getStudy",
        "parameters": [
          {
            "$ref": "#/components/parameters/causeVariableNameParam"
          },
          {
            "$ref": "#/components/parameters/effectVariableNameParam"
          },
          {
            "$ref": "#/components/parameters/causeVariableIdParam"
          },
          {
            "$ref": "#/components/parameters/effectVariableIdParam"
          },
          {
            "$ref": "#/components/parameters/predictorVariableNameParam"
          },
          {
            "$ref": "#/components/parameters/outcomeVariableNameParam"
          },
          {
            "$ref": "#/components/parameters/userIdParam"
          },
          {
            "$ref": "#/components/parameters/clientIdParam"
          },
          {
            "$ref": "#/components/parameters/includeChartsParam"
          },
          {
            "$ref": "#/components/parameters/recalculate"
          },
          {
            "$ref": "#/components/parameters/studyClientIdParam"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Study"
                }
              }
            }
          },
          "401": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/JsonErrorResponse"
                }
              }
            }
          },
          "404": {
            "description": "Not found",
            "content": {}
          },
          "500": {
            "description": "Internal server error",
            "content": {}
          }
        },
        "security": [
          {
            "bearerAuth": []
          },
          {
            "curedao_oauth2": [
              "basic"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Button": {
        "required": [
          "link",
          "text"
        ],
        "type": "object",
        "properties": {
          "accessibilityText": {
            "type": "string",
            "description": "Ex: connect"
          },
          "action": {
            "type": "object",
            "properties": {},
            "description": "Action data"
          },
          "additionalInformation": {
            "type": "string",
            "description": "Ex: connect"
          },
          "color": {
            "type": "string",
            "description": "Ex: #f2f2f2"
          },
          "confirmationText": {
            "type": "string",
            "description": "Text to show user before executing functionName"
          },
          "functionName": {
            "type": "string",
            "description": "Name of function to call"
          },
          "parameters": {
            "type": "object",
            "properties": {},
            "description": "Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API"
          },
          "html": {
            "type": "string",
            "description": "Ex: connect"
          },
          "id": {
            "type": "string",
            "description": "HTML element id"
          },
          "image": {
            "type": "string",
            "description": "Ex: https://image.jpg"
          },
          "ionIcon": {
            "type": "string",
            "description": "Ex: ion-refresh"
          },
          "link": {
            "type": "string",
            "description": "Ex: https://local.quantimo.do"
          },
          "stateName": {
            "type": "string",
            "description": "State to go to"
          },
          "stateParams": {
            "type": "object",
            "properties": {},
            "description": "Data to provide to the state"
          },
          "successToastText": {
            "type": "string",
            "description": "Text to show user after executing functionName"
          },
          "successAlertTitle": {
            "type": "string",
            "description": "Text to show user after executing functionName"
          },
          "successAlertBody": {
            "type": "string",
            "description": "Text to show user after executing functionName"
          },
          "text": {
            "type": "string",
            "description": "Ex: Connect"
          },
          "tooltip": {
            "type": "string",
            "description": "Ex: This is a tooltip"
          },
          "webhookUrl": {
            "type": "string",
            "description": "Post here on button click"
          }
        }
      },
      "Card": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "actionSheetButtons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Button"
            }
          },
          "avatar": {
            "type": "string",
            "description": "Smaller square image"
          },
          "avatarCircular": {
            "type": "string",
            "description": "Smaller circular image"
          },
          "backgroundColor": {
            "type": "string",
            "description": "Ex: #f2f2f2"
          },
          "buttons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Button"
            }
          },
          "buttonsSecondary": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Button"
            }
          },
          "content": {
            "type": "string",
            "description": "Ex: Content"
          },
          "headerTitle": {
            "type": "string",
            "description": "Ex: Title"
          },
          "html": {
            "type": "string",
            "description": "HTML for the entire card."
          },
          "htmlContent": {
            "type": "string",
            "description": "Ex: <div>Content</div>"
          },
          "id": {
            "type": "string",
            "description": "HTML element id"
          },
          "image": {
            "type": "string",
            "description": "Larger image of variable dimensions"
          },
          "inputFields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InputField"
            }
          },
          "ionIcon": {
            "type": "string",
            "description": "Ex: ion-refresh"
          },
          "link": {
            "type": "string",
            "description": "A link to a web page or something. Not much more to say about that."
          },
          "parameters": {
            "type": "object",
            "properties": {},
            "description": "Key value pairs derived from user input fields, button clicks, or preset defaults"
          },
          "relatedCards": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Card"
            }
          },
          "selectedButton": {
            "$ref": "#/components/schemas/Button"
          },
          "sharingBody": {
            "type": "string",
            "description": "Ex: sharingBody"
          },
          "sharingButtons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Button"
            }
          },
          "sharingTitle": {
            "type": "string",
            "description": "Ex: sharingTitle"
          },
          "subHeader": {
            "type": "string",
            "description": "Ex: subTitle"
          },
          "subTitle": {
            "type": "string",
            "description": "Ex: subTitle"
          },
          "title": {
            "type": "string",
            "description": "Ex: Title"
          }
        }
      },
      "Chart": {
        "type": "object",
        "properties": {
          "highchartConfig": {
            "type": "object",
            "properties": {},
            "description": " Highcharts config that can be used if you have highcharts.js included on the page"
          },
          "chartId": {
            "type": "string",
            "description": "Ex: correlationScatterPlot"
          },
          "chartTitle": {
            "type": "string",
            "description": "Ex: Overall Mood following Sleep Duration (R = -0.173)"
          },
          "explanation": {
            "type": "string",
            "description": "Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood."
          },
          "svgUrl": {
            "type": "string",
            "description": "Url to a static svg of the chart"
          },
          "svg": {
            "type": "string",
            "description": "SVG string than can be embedded directly in HTML"
          }
        }
      },
      "ConnectInstructions": {
        "required": [
          "url"
        ],
        "type": "object",
        "properties": {
          "parameters": {
            "type": "array",
            "description": "Create a form with these fields and post the key and user submitted value to the provided connect url",
            "items": {
              "type": "object",
              "properties": {}
            }
          },
          "url": {
            "type": "string",
            "description": "URL to open to connect"
          },
          "usePopup": {
            "type": "boolean",
            "description": "True if should open auth window in popup"
          }
        }
      },
      "ConversionStep": {
        "required": [
          "operation",
          "value"
        ],
        "type": "object",
        "properties": {
          "operation": {
            "type": "string",
            "description": "ADD or MULTIPLY",
            "enum": [
              "ADD",
              "MULTIPLY"
            ]
          },
          "value": {
            "type": "number",
            "description": "This specifies the order of conversion steps starting with 0",
            "format": "double"
          }
        }
      },
      "Correlation": {
        "required": [
          "causeVariableName",
          "effectVariableName"
        ],
        "type": "object",
        "properties": {
          "averageDailyHighCause": {
            "type": "number",
            "description": "Ex: 4.19",
            "format": "double"
          },
          "averageDailyLowCause": {
            "type": "number",
            "description": "Ex: 1.97",
            "format": "double"
          },
          "averageEffect": {
            "type": "number",
            "description": "Ex: 3.0791054117396",
            "format": "double"
          },
          "averageEffectFollowingHighCause": {
            "type": "number",
            "description": "Ex: 3.55",
            "format": "double"
          },
          "averageEffectFollowingLowCause": {
            "type": "number",
            "description": "Ex: 2.65",
            "format": "double"
          },
          "averageForwardPearsonCorrelationOverOnsetDelays": {
            "type": "number",
            "description": "Ex: 0.396",
            "format": "double"
          },
          "averageReversePearsonCorrelationOverOnsetDelays": {
            "type": "number",
            "description": "Ex: 0.453667",
            "format": "double"
          },
          "averageVote": {
            "type": "number",
            "description": "Ex: 0.9855"
          },
          "causeChanges": {
            "type": "integer",
            "description": "Ex: 164"
          },
          "causeDataSource": {
            "$ref": "#/components/schemas/DataSource"
          },
          "causeUserVariableShareUserMeasurements": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "causeVariableCategoryId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "causeVariableCategoryName": {
            "type": "string",
            "description": "Ex: Sleep"
          },
          "causeVariableCombinationOperation": {
            "type": "string",
            "description": "Ex: MEAN"
          },
          "causeVariableUnitAbbreviatedName": {
            "type": "string",
            "description": "Ex: /5"
          },
          "causeVariableId": {
            "type": "integer",
            "description": "Ex: 1448"
          },
          "causeVariableMostCommonConnectorId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "causeVariableName": {
            "type": "string",
            "description": "Ex: Sleep Quality"
          },
          "confidenceInterval": {
            "type": "number",
            "description": "Ex: 0.14344467795996",
            "format": "double"
          },
          "confidenceLevel": {
            "type": "string",
            "description": "Ex: high"
          },
          "correlationCoefficient": {
            "type": "number",
            "description": "Ex: 0.538",
            "format": "double"
          },
          "correlationIsContradictoryToOptimalValues": {
            "type": "boolean",
            "description": "Ex: false"
          },
          "createdAt": {
            "type": "string",
            "description": "Ex: 2016-12-28 20:47:30 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "criticalTValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 1.646",
            "format": "double"
          },
          "direction": {
            "type": "string",
            "description": "Ex: higher"
          },
          "durationOfAction": {
            "type": "integer",
            "description": "User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay.  Unit: Seconds"
          },
          "durationOfActionInHours": {
            "type": "number",
            "description": "User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay.  Unit: Hours",
            "format": "float"
          },
          "degreesOfFreedom": {
            "type": "integer",
            "description": "Ex: 200"
          },
          "effectNumberOfProcessedDailyMeasurements": {
            "type": "integer",
            "description": "Ex: 145"
          },
          "error": {
            "type": "string",
            "description": "Ex: optimalPearsonProduct is not defined"
          },
          "effectChanges": {
            "type": "integer",
            "description": "Ex: 193"
          },
          "effectDataSource": {
            "$ref": "#/components/schemas/DataSource"
          },
          "effectSize": {
            "type": "string",
            "description": "Ex: moderately positive"
          },
          "effectUnit": {
            "type": "string",
            "description": "Ex: /5"
          },
          "effectUserVariableShareUserMeasurements": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "effectVariableCategoryId": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "effectVariableCategoryName": {
            "type": "string",
            "description": "Ex: Emotions"
          },
          "effectVariableCombinationOperation": {
            "type": "string",
            "description": "Ex: MEAN"
          },
          "effectVariableCommonAlias": {
            "type": "string",
            "description": "Ex: Mood_(psychology)"
          },
          "effectVariableUnitAbbreviatedName": {
            "type": "string",
            "description": "Ex: /5"
          },
          "effectVariableUnitId": {
            "type": "integer",
            "description": "Ex: 10"
          },
          "effectVariableUnitName": {
            "type": "string",
            "description": "Ex: 1 to 5 Rating"
          },
          "effectVariableId": {
            "type": "integer",
            "description": "Ex: 1398"
          },
          "effectVariableMostCommonConnectorId": {
            "type": "integer",
            "description": "Ex: 10"
          },
          "effectVariableName": {
            "type": "string",
            "description": "Ex: Overall Mood"
          },
          "experimentEndTime": {
            "type": "string",
            "description": "Ex: 2014-07-30 12:50:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "experimentStartTime": {
            "type": "string",
            "description": "Ex: 2012-05-06 21:15:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "forwardSpearmanCorrelationCoefficient": {
            "type": "number",
            "description": "Ex: 0.528359",
            "format": "double"
          },
          "numberOfPairs": {
            "type": "integer",
            "description": "Ex: 298"
          },
          "onsetDelay": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "onsetDelayInHours": {
            "type": "number",
            "description": "Ex: 0",
            "format": "float"
          },
          "onsetDelayWithStrongestPearsonCorrelation": {
            "type": "integer",
            "description": "Ex: -86400"
          },
          "onsetDelayWithStrongestPearsonCorrelationInHours": {
            "type": "number",
            "description": "Ex: -24",
            "format": "float"
          },
          "optimalPearsonProduct": {
            "type": "number",
            "description": "Ex: 0.68582816186982",
            "format": "double"
          },
          "outcomeFillingValue": {
            "type": "integer",
            "description": "User-Defined Variable Setting: Ex: -1. Unit: User-specified or common."
          },
          "outcomeMaximumAllowedValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: Ex: 23. Unit: User-specified or common.",
            "format": "double"
          },
          "outcomeMinimumAllowedValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: Ex: 0.1. Unit: User-specified or common.",
            "format": "double"
          },
          "pearsonCorrelationWithNoOnsetDelay": {
            "type": "number",
            "description": "Ex: 0.477",
            "format": "double"
          },
          "predictivePearsonCorrelation": {
            "type": "number",
            "description": "Ex: 0.538",
            "format": "double"
          },
          "predictivePearsonCorrelationCoefficient": {
            "type": "number",
            "description": "Ex: 0.538",
            "format": "double"
          },
          "predictorDataSources": {
            "type": "string",
            "description": "Ex: RescueTime"
          },
          "predictorFillingValue": {
            "type": "integer",
            "description": "Ex: -1. Unit: User-specified or common."
          },
          "predictorMaximumAllowedValue": {
            "type": "number",
            "description": "Ex: 200. Unit: User-specified or common.",
            "format": "double"
          },
          "predictorMinimumAllowedValue": {
            "type": "number",
            "description": "Ex: 30. Unit: User-specified or common.",
            "format": "double"
          },
          "predictsHighEffectChange": {
            "type": "integer",
            "description": "Ex: 17. Unit: User-specified or common."
          },
          "predictsLowEffectChange": {
            "type": "integer",
            "description": "Ex: -11. Unit: User-specified or common."
          },
          "pValue": {
            "type": "number",
            "description": "Ex: 0.39628900511586",
            "format": "double"
          },
          "qmScore": {
            "type": "number",
            "description": "Ex: 0.528",
            "format": "double"
          },
          "reversePearsonCorrelationCoefficient": {
            "type": "number",
            "description": "Ex: 0.01377184270977",
            "format": "double"
          },
          "shareUserMeasurements": {
            "type": "boolean",
            "description": "Would you like to make this study publicly visible?"
          },
          "sharingDescription": {
            "type": "string",
            "description": "Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood"
          },
          "sharingTitle": {
            "type": "string",
            "description": "Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood"
          },
          "significantDifference": {
            "type": "boolean",
            "description": "Ex: 1"
          },
          "statisticalSignificance": {
            "type": "number",
            "description": "Ex: 0.9813",
            "format": "double"
          },
          "strengthLevel": {
            "type": "string",
            "description": "Ex: moderate"
          },
          "strongestPearsonCorrelationCoefficient": {
            "type": "number",
            "description": "Ex: 0.613",
            "format": "double"
          },
          "studyHtml": {
            "$ref": "#/components/schemas/StudyHtml"
          },
          "studyImages": {
            "$ref": "#/components/schemas/StudyImages"
          },
          "studyLinks": {
            "$ref": "#/components/schemas/StudyLinks"
          },
          "studyText": {
            "$ref": "#/components/schemas/StudyText"
          },
          "tValue": {
            "type": "number",
            "description": "Ex: 9.6986079652717",
            "format": "double"
          },
          "updatedAt": {
            "type": "string",
            "description": "Ex: 2017-05-06 15:40:38 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "userId": {
            "type": "integer",
            "description": "Ex: 230"
          },
          "userVote": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "valuePredictingHighOutcome": {
            "type": "number",
            "description": "Ex: 4.14",
            "format": "double"
          },
          "valuePredictingLowOutcome": {
            "type": "number",
            "description": "Ex: 3.03",
            "format": "double"
          },
          "outcomeDataSources": {
            "type": "string",
            "description": "Sources used to collect data for the outcome variable"
          },
          "principalInvestigator": {
            "type": "string",
            "description": "Mike Sinn"
          },
          "reverseCorrelation": {
            "type": "number",
            "description": "Correlation when cause and effect are reversed. For any causal relationship, the forward correlation should exceed the reverse correlation."
          },
          "averagePearsonCorrelationCoefficientOverOnsetDelays": {
            "type": "number",
            "description": "Ex: ",
            "format": "float"
          },
          "causeNumberOfRawMeasurements": {
            "type": "integer",
            "description": "Ex: 14764"
          },
          "correlationsOverDurationsOfAction": {
            "type": "array",
            "description": "Correlations calculated with various duration of action hyper-parameters",
            "items": {
              "$ref": "#/components/schemas/Correlation"
            }
          },
          "correlationsOverOnsetDelays": {
            "type": "array",
            "description": "Correlations calculated with various onset delay hyper-parameters",
            "items": {
              "$ref": "#/components/schemas/Correlation"
            }
          },
          "correlationsOverDurationsOfActionChartConfig": {
            "type": "object",
            "properties": {},
            "description": "Highchart config illustrating correlations calculated with various duration of action hyper-parameters"
          },
          "correlationsOverOnsetDelaysChartConfig": {
            "type": "object",
            "properties": {},
            "description": "Highchart config illustrating correlations calculated with various onset delay hyper-parameters"
          },
          "numberOfUsers": {
            "type": "number",
            "description": "Ex: 1"
          },
          "rawCauseMeasurementSignificance": {
            "type": "number",
            "description": "Ex: 1",
            "format": "double"
          },
          "rawEffectMeasurementSignificance": {
            "type": "number",
            "description": "Ex: 1",
            "format": "double"
          },
          "reversePairsCount": {
            "type": "string",
            "description": "Ex: 1"
          },
          "voteStatisticalSignificance": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "aggregateQMScore": {
            "type": "number",
            "description": "Ex: 0.011598441286655",
            "format": "double"
          },
          "forwardPearsonCorrelationCoefficient": {
            "type": "number",
            "description": "Ex: 0.0333",
            "format": "double"
          },
          "numberOfCorrelations": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "vote": {
            "type": "number",
            "description": "Ex: 1 or 0"
          }
        }
      },
      "DataSource": {
        "required": [
          "affiliate",
          "connectorClientId",
          "defaultVariableCategoryName",
          "displayName",
          "enabled",
          "getItUrl",
          "id",
          "image",
          "imageHtml",
          "linkedDisplayNameHtml",
          "longDescription",
          "name",
          "shortDescription"
        ],
        "type": "object",
        "properties": {
          "affiliate": {
            "type": "boolean",
            "description": "Ex: true"
          },
          "backgroundColor": {
            "type": "string",
            "description": "Background color HEX code that matches the icon"
          },
          "buttons": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Button"
            }
          },
          "card": {
            "$ref": "#/components/schemas/Card"
          },
          "clientId": {
            "type": "string",
            "description": "Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do"
          },
          "connected": {
            "type": "boolean",
            "description": "True if the authenticated user has this connector enabled"
          },
          "connectError": {
            "type": "string",
            "description": "Ex: Your token is expired. Please re-connect"
          },
          "connectInstructions": {
            "$ref": "#/components/schemas/ConnectInstructions"
          },
          "connectorId": {
            "type": "integer",
            "description": "Ex: 8"
          },
          "connectStatus": {
            "type": "string",
            "description": "Ex: CONNECTED"
          },
          "count": {
            "type": "integer",
            "description": "Number of measurements from this source or number of users who have measurements from this source"
          },
          "createdAt": {
            "type": "string",
            "description": "Ex: 2000-01-01 00:00:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "connectorClientId": {
            "type": "string",
            "description": "Ex: ba7d0c12432650e23b3ce924ae2d21e2ff59e7e4e28650759633700af7ed0a30"
          },
          "defaultVariableCategoryName": {
            "type": "string",
            "description": "Ex: Foods"
          },
          "displayName": {
            "type": "string",
            "description": "Ex: CureDAO"
          },
          "enabled": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "getItUrl": {
            "type": "string",
            "description": "Ex: https://curedao.org"
          },
          "id": {
            "type": "integer",
            "description": "Ex: 72"
          },
          "image": {
            "type": "string",
            "description": "Ex: https://web.quantimo.do/img/logos/curedao-logo-qm-rainbow-200-200.png"
          },
          "imageHtml": {
            "type": "string",
            "description": "Ex: <a href=\"https://curedao.org\"><img id=\"curedao_image\" title=\"CureDAO\" src=\"https://web.quantimo.do/img/logos/curedao-logo-qm-rainbow-200-200.png\" alt=\"CureDAO\"></a>"
          },
          "lastSuccessfulUpdatedAt": {
            "type": "string",
            "description": "Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "lastUpdate": {
            "type": "integer",
            "description": "Epoch timestamp of last sync"
          },
          "linkedDisplayNameHtml": {
            "type": "string",
            "description": "Ex: <a href=\"https://curedao.org\">CureDAO</a>"
          },
          "longDescription": {
            "type": "string",
            "description": "Ex: CureDAO is a Chrome extension, Android app, iOS app, and web app that allows you to easily track mood, symptoms, or any outcome you want to optimize in a fraction of a second.  You can also import your data from over 30 other apps and devices like Fitbit, Rescuetime, Jawbone Up, Withings, Facebook, Github, Google Calendar, Runkeeper, MoodPanda, Slice, Google Fit, and more.  CureDAO then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values."
          },
          "message": {
            "type": "string",
            "description": "Ex: Got 412 new measurements on 2017-07-31 10:10:34"
          },
          "mobileConnectMethod": {
            "type": "string",
            "description": "Mobile connect method: webview, cordova, google, spreadsheet, or ip"
          },
          "name": {
            "type": "string",
            "description": "Ex: curedao"
          },
          "platforms": {
            "type": "array",
            "description": "Platforms (chrome, android, ios, web) that you can connect on.",
            "items": {
              "type": "string"
            }
          },
          "premium": {
            "type": "boolean",
            "description": "True if connection requires upgrade"
          },
          "scopes": {
            "type": "array",
            "description": "Required connector scopes",
            "items": {
              "type": "string"
            }
          },
          "shortDescription": {
            "type": "string",
            "description": "Ex: Tracks anything"
          },
          "spreadsheetUploadLink": {
            "type": "string",
            "description": "URL to POST a spreadsheet to (if available for this data source)"
          },
          "totalMeasurementsInLastUpdate": {
            "type": "integer",
            "description": "Number of measurements obtained during latest update"
          },
          "updatedAt": {
            "type": "string",
            "description": "Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "updateRequestedAt": {
            "type": "string",
            "description": "Ex: 2017-07-18 05:16:31 UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "updateStatus": {
            "type": "string",
            "description": "Ex: UPDATED"
          },
          "userId": {
            "type": "integer",
            "description": "Ex: 230"
          }
        }
      },
      "Error": {
        "required": [
          "message"
        ],
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          }
        }
      },
      "InputField": {
        "required": [
          "displayName",
          "type"
        ],
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string"
          },
          "helpText": {
            "type": "string"
          },
          "hint": {
            "type": "string"
          },
          "icon": {
            "type": "string"
          },
          "id": {
            "type": "string",
            "description": "HTML element id"
          },
          "image": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "labelLeft": {
            "type": "string"
          },
          "labelRight": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "maxLength": {
            "type": "integer"
          },
          "maxValue": {
            "type": "number"
          },
          "minLength": {
            "type": "integer"
          },
          "minValue": {
            "type": "number"
          },
          "options": {
            "type": "array",
            "description": "Selector list options",
            "items": {
              "type": "string"
            }
          },
          "placeholder": {
            "type": "string",
            "description": "Ex: Title"
          },
          "postUrl": {
            "type": "string"
          },
          "required": {
            "type": "boolean"
          },
          "show": {
            "type": "boolean",
            "description": "Ex: Title"
          },
          "submitButton": {
            "$ref": "#/components/schemas/Button"
          },
          "type": {
            "type": "string",
            "description": "Ex: Title",
            "enum": [
              "check_box",
              "date",
              "email",
              "number",
              "postal_code",
              "select_option",
              "string",
              "switch",
              "text_area",
              "unit",
              "variable_category"
            ]
          },
          "validationPattern": {
            "type": "string",
            "description": "See http://html5pattern.com/ for examples"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "JsonErrorResponse": {
        "required": [
          "status"
        ],
        "type": "object",
        "properties": {
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "description": {
            "type": "string",
            "description": "Can be used as body of help info popup"
          },
          "summary": {
            "type": "string",
            "description": "Can be used as title in help info popup"
          },
          "errors": {
            "type": "array",
            "description": "Array of error objects with message property",
            "items": {
              "$ref": "#/components/schemas/Error"
            }
          },
          "status": {
            "type": "string",
            "description": "ex. OK or ERROR"
          },
          "success": {
            "type": "boolean",
            "description": "true or false"
          },
          "code": {
            "type": "number",
            "description": "Response code such as 200"
          },
          "link": {
            "type": "string",
            "description": "A super neat url you might want to share with your users!"
          },
          "card": {
            "$ref": "#/components/schemas/Card"
          }
        }
      },
      "ParticipantInstruction": {
        "type": "object",
        "properties": {
          "instructionsForCauseVariable": {
            "type": "string",
            "description": "Ex: <a href=\"https://www.amazon.com/Fitbit-Charge-Heart-Fitness-Wristband/dp/B01K9S260E/ref=as_li_ss_tl?ie=UTF8&qid=1493518902&sr=8-3&keywords=fitbit&th=1&linkCode=ll1&tag=quant08-20&linkId=b357b0833de73b0c4e935fd7c13a079e\">Obtain Fitbit</a> and use it to record your Sleep Duration. Once you have a <a href=\"https://www.amazon.com/Fitbit-Charge-Heart-Fitness-Wristband/dp/B01K9S260E/ref=as_li_ss_tl?ie=UTF8&qid=1493518902&sr=8-3&keywords=fitbit&th=1&linkCode=ll1&tag=quant08-20&linkId=b357b0833de73b0c4e935fd7c13a079e\">Fitbit</a> account, <a href=\"https://web.quantimo.do/#/app/import\">connect your  Fitbit account at CureDAO</a> to automatically import and analyze your data."
          },
          "instructionsForEffectVariable": {
            "type": "string",
            "description": "Ex: <a href=\"https://curedao.org\">Obtain CureDAO</a> and use it to record your Overall Mood. Once you have a <a href=\"https://curedao.org\">CureDAO</a> account, <a href=\"https://web.quantimo.do/#/app/import\">connect your  CureDAO account at CureDAO</a> to automatically import and analyze your data."
          }
        }
      },
      "Study": {
        "required": [
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Ex: population, cohort, or individual"
          },
          "userId": {
            "type": "integer",
            "description": "The user id of the principal investigator or subject if an individual studies",
            "format": "int32"
          },
          "id": {
            "type": "string",
            "description": "ID of the cohort study which is necessary to allow participants to join"
          },
          "causeVariable": {
            "$ref": "#/components/schemas/Variable"
          },
          "causeVariableName": {
            "type": "string",
            "description": "Ex: Sleep Quality"
          },
          "studyCharts": {
            "$ref": "#/components/schemas/StudyCharts"
          },
          "effectVariable": {
            "$ref": "#/components/schemas/Variable"
          },
          "effectVariableName": {
            "type": "string",
            "description": "Ex: Overall Mood"
          },
          "participantInstructions": {
            "$ref": "#/components/schemas/ParticipantInstruction"
          },
          "statistics": {
            "$ref": "#/components/schemas/Correlation"
          },
          "studyCard": {
            "$ref": "#/components/schemas/Card"
          },
          "studyHtml": {
            "$ref": "#/components/schemas/StudyHtml"
          },
          "studyImages": {
            "$ref": "#/components/schemas/StudyImages"
          },
          "studyLinks": {
            "$ref": "#/components/schemas/StudyLinks"
          },
          "studySharing": {
            "$ref": "#/components/schemas/StudySharing"
          },
          "studyText": {
            "$ref": "#/components/schemas/StudyText"
          },
          "studyVotes": {
            "$ref": "#/components/schemas/StudyVotes"
          },
          "joined": {
            "type": "boolean",
            "description": "True if you are sharing your data with this study"
          }
        },
        "description": "A study analyzes the relationship between a predictor variable like gluten-intake and an outcome of interest such as overall mood."
      },
      "StudyCharts": {
        "type": "object",
        "properties": {
          "populationTraitScatterPlot": {
            "$ref": "#/components/schemas/Chart"
          },
          "outcomeDistributionColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "predictorDistributionColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "correlationScatterPlot": {
            "$ref": "#/components/schemas/Chart"
          },
          "pairsOverTimeLineChart": {
            "$ref": "#/components/schemas/Chart"
          }
        },
        "description": "An object with various chart properties each property contain and svg and Highcharts configuration"
      },
      "StudyHtml": {
        "required": [
          "chartHtml",
          "fullStudyHtml"
        ],
        "type": "object",
        "properties": {
          "chartHtml": {
            "type": "string",
            "description": "Embeddable chart html"
          },
          "downloadButtonsHtml": {
            "type": "string",
            "description": "Play Store, App Store, Chrome Web Store"
          },
          "fullPageWithHead": {
            "type": "string",
            "description": "Embeddable study including HTML head section charts.  Modifiable css classes are study-title, study-section-header, study-section-body"
          },
          "fullStudyHtml": {
            "type": "string",
            "description": "Embeddable study text html including charts.  Modifiable css classes are study-title, study-section-header, study-section-body"
          },
          "fullStudyHtmlWithCssStyles": {
            "type": "string",
            "description": "Embeddable study html including charts and css styling"
          },
          "participantInstructionsHtml": {
            "type": "string",
            "description": "Instructions for study participation"
          },
          "statisticsTableHtml": {
            "type": "string",
            "description": "Embeddable table with statistics"
          },
          "studyAbstractHtml": {
            "type": "string",
            "description": "Text summary"
          },
          "studyHeaderHtml": {
            "type": "string",
            "description": "Title, study image, abstract with CSS styling"
          },
          "studyImageHtml": {
            "type": "string",
            "description": "PNG image"
          },
          "studyMetaHtml": {
            "type": "string",
            "description": "Facebook, Twitter, Google+"
          },
          "studyTextHtml": {
            "type": "string",
            "description": "Formatted study text sections"
          },
          "socialSharingButtonHtml": {
            "type": "string"
          },
          "studySummaryBoxHtml": {
            "type": "string"
          }
        }
      },
      "StudyImages": {
        "required": [
          "gaugeImage",
          "gaugeImageSquare",
          "imageUrl"
        ],
        "type": "object",
        "properties": {
          "causeVariableImageUrl": {
            "type": "string",
            "description": "Ex: https://static.quantimo.do/img/variable_categories/sleeping_in_bed-96.png"
          },
          "causeVariableIonIcon": {
            "type": "string",
            "description": "Ex: ion-ios-cloudy-night-outline"
          },
          "effectVariableImageUrl": {
            "type": "string",
            "description": "Ex: https://static.quantimo.do/img/variable_categories/theatre_mask-96.png"
          },
          "effectVariableIonIcon": {
            "type": "string",
            "description": "Ex: ion-happy-outline"
          },
          "gaugeImage": {
            "type": "string",
            "description": "Ex: https://s3.amazonaws.com/curedao-docs/images/gauge-moderately-positive-relationship.png"
          },
          "gaugeImageSquare": {
            "type": "string",
            "description": "Ex: https://s3.amazonaws.com/curedao-docs/images/gauge-moderately-positive-relationship-200-200.png"
          },
          "gaugeSharingImageUrl": {
            "type": "string",
            "description": "Image with gauge and category images"
          },
          "imageUrl": {
            "type": "string",
            "description": "Ex: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-moderately-positive-relationship_sleep_emotions_logo_background.png"
          },
          "robotSharingImageUrl": {
            "type": "string",
            "description": "Image with robot and category images"
          },
          "avatar": {
            "type": "string",
            "description": "Avatar of the principal investigator"
          }
        }
      },
      "StudyLinks": {
        "required": [
          "studyLinkDynamic",
          "studyLinkEmail",
          "studyLinkFacebook",
          "studyLinkGoogle",
          "studyLinkStatic",
          "studyLinkTwitter"
        ],
        "type": "object",
        "properties": {
          "studyJoinLink": {
            "type": "string",
            "description": "Share this link with potential study participants"
          },
          "studyLinkEmail": {
            "type": "string",
            "description": "Ex: mailto:?subject=N1%20Study%3A%20Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%0A%0AHave%20a%20great%20day!"
          },
          "studyLinkFacebook": {
            "type": "string",
            "description": "Ex: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230"
          },
          "studyLinkGoogle": {
            "type": "string",
            "description": "Ex: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230"
          },
          "studyLinkStatic": {
            "type": "string",
            "description": "Ex: https://local.quantimo.do/api/v2/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230"
          },
          "studyLinkDynamic": {
            "type": "string",
            "description": "Ex: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230"
          },
          "studyLinkTwitter": {
            "type": "string",
            "description": "Ex: https://twitter.com/home?status=Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%20%40curedao"
          }
        }
      },
      "StudySharing": {
        "required": [
          "shareUserMeasurements",
          "sharingDescription",
          "sharingTitle"
        ],
        "type": "object",
        "properties": {
          "shareUserMeasurements": {
            "type": "boolean",
            "description": "Would you like to make this study publicly visible?"
          },
          "sharingDescription": {
            "type": "string",
            "description": "Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood"
          },
          "sharingTitle": {
            "type": "string",
            "description": "Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood"
          }
        }
      },
      "StudyText": {
        "required": [
          "studyAbstract",
          "studyDesign",
          "studyLimitations",
          "studyObjective",
          "studyResults",
          "studyTitle"
        ],
        "type": "object",
        "properties": {
          "averageEffectFollowingHighCauseExplanation": {
            "type": "string",
            "description": "Ex: Overall Mood is 3.55/5 (15% higher) on average after days with around 4.19/5 Sleep Quality"
          },
          "averageEffectFollowingLowCauseExplanation": {
            "type": "string",
            "description": "Ex: Overall Mood is 2.65/5 (14% lower) on average after days with around 1.97/5 Sleep Quality"
          },
          "valuePredictingHighOutcomeExplanation": {
            "type": "string",
            "description": "Ex: Overall Mood, on average, 17% higher after around 4.14/5 Sleep Quality"
          },
          "valuePredictingLowOutcomeExplanation": {
            "type": "string",
            "description": "Ex: Overall Mood, on average, 11% lower after around 3.03/5 Sleep Quality"
          },
          "dataAnalysis": {
            "type": "string",
            "description": "Ex: It was assumed that 0 hours would pass before a change in Very Distracting Time would produce an observable change in Video Activities.  It was assumed that Very Distracting Time could produce an observable change in Video Activities for as much as 7 days after the stimulus event."
          },
          "dataSources": {
            "type": "string",
            "description": "Ex: Very Distracting Time data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs.<br>Video Activities data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs."
          },
          "dataSourcesParagraphForCause": {
            "type": "string",
            "description": "Ex: Very Distracting Time data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs.<br>Video Activities data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs."
          },
          "dataSourcesParagraphForEffect": {
            "type": "string",
            "description": "Ex: Very Distracting Time data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs.<br>Video Activities data was primarily collected using <a href=\"https://www.rescuetime.com/rp/curedao/plans\">RescueTime</a>. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs."
          },
          "lastCauseDailyValueSentenceExtended": {
            "type": "string",
            "description": "Ex: Sleep Quality Predicts Higher Overall Mood"
          },
          "lastCauseAndOptimalValueSentence": {
            "type": "string",
            "description": "Ex: Sleep Quality Predicts Higher Overall Mood"
          },
          "lastCauseDailyValueSentence": {
            "type": "string",
            "description": "Ex: Sleep Quality Predicts Higher Overall Mood"
          },
          "optimalDailyValueSentence": {
            "type": "string",
            "description": "Ex: Sleep Quality Predicts Higher Overall Mood"
          },
          "participantInstructions": {
            "type": "string",
            "description": "Instructions for study participation"
          },
          "predictorExplanation": {
            "type": "string",
            "description": "Ex: Sleep Quality Predicts Higher Overall Mood"
          },
          "significanceExplanation": {
            "type": "string",
            "description": "Ex: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Video Activities is statistically significant at 95% confidence interval."
          },
          "studyAbstract": {
            "type": "string",
            "description": "Ex: Aggregated data from 21 suggests with a low degree of confidence (p=0.097) that Very Distracting Time has a moderately positive predictive relationship (R=0.354) with Video Activities  (Activity).  The highest quartile of Video Activities measurements were observed following an average 2.03h Very Distracting Timeper day.  The lowest quartile of Video Activities  measurements were observed following an average 1.04h Very Distracting Timeper day."
          },
          "studyDesign": {
            "type": "string",
            "description": "Ex: This study is based on data donated by  21 CureDAO users. Thus, the study design is equivalent to the aggregation of 21 separate n=1 observational natural experiments."
          },
          "studyLimitations": {
            "type": "string",
            "description": "Ex: As with any human experiment, it was impossible to control for all potentially confounding variables.\n            Correlation does not necessarily imply correlation.  We can never know for sure if one factor is definitely the cause of an outcome.\n            However, lack of correlation definitely implies the lack of a causal relationship.  Hence, we can with great\n            confidence rule out non-existent relationships. For instance, if we discover no relationship between mood\n            and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship.\n            <br>\n            <br>\n            We can also take advantage of several characteristics of time series data from many subjects  to infer the likelihood of a causal relationship if we do find a correlational relationship.\n            The criteria for causation are a group of minimal conditions necessary to provide adequate evidence of a causal relationship between an incidence and a possible consequence.\n            The list of the criteria is as follows:\n            <br>\n            1. Strength (effect size): A small association does not mean that there is not a causal effect, though the larger the association, the more likely that it is causal.\n            <br>\n            2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect.\n            <br>\n            3. Specificity: Causation is likely if a very specific population at a specific site and disease with no other likely explanation. The more specific an association between a factor and an effect is, the bigger the probability of a causal relationship.\n            <br>\n            4. Temporality: The effect has to occur after the cause (and if there is an expected delay between the cause and expected effect, then the effect must occur after that delay).\n            <br>\n            5. Biological gradient: Greater exposure should generally lead to greater incidence of the effect. However, in some cases, the mere presence of the factor can trigger the effect. In other cases, an inverse proportion is observed: greater exposure leads to lower incidence.\n            <br>\n            6. Plausibility: A plausible mechanism between cause and effect is helpful.\n            <br>\n            7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect.\n            <br>\n            8. Experiment: \"Occasionally it is possible to appeal to experimental evidence\".\n            <br>\n            9. Analogy: The effect of similar factors may be considered.\n            <br>\n            <br>\n             The confidence in a causal relationship is bolstered by the fact that time-precedence was taken into account in all calculations. Furthermore, in accordance with the law of large numbers (LLN), the predictive power and accuracy of these results will continually grow over time.  146 paired data points were used in this analysis.   Assuming that the relationship is merely coincidental, as the participant independently modifies their Very Distracting Time values, the observed strength of the relationship will decline until it is below the threshold of significance.  To it another way, in the case that we do find a spurious correlation, suggesting that banana intake improves mood for instance,\n            one will likely increase their banana intake.  Due to the fact that this correlation is spurious, it is unlikely\n            that you will see a continued and persistent corresponding increase in mood.  So over time, the spurious correlation will\n            naturally dissipate.Furthermore, it will be very enlightening to aggregate this data with the data from other participants  with similar genetic, diseasomic, environmentomic, and demographic profiles."
          },
          "studyObjective": {
            "type": "string",
            "description": "Ex: The objective of this study is to determine the nature of the relationship (if any) between the Very Distracting Time and the Video Activities. Additionally, we attempt to determine the Very Distracting Time values most likely to produce optimal Video Activities values."
          },
          "studyResults": {
            "type": "string",
            "description": "Ex: This analysis suggests that higher Very Distracting Time generally predicts negative Video Activities (p = 0.097). Video Activities is, on average, 36%  higher after around 2.03 Very Distracting Time.  After an onset delay of 168 hours, Video Activities is, on average, 16%  lower than its average over the 168 hours following around 1.04 Very Distracting Time.  146 data points were used in this analysis.  The value for Very Distracting Time changed 2984 times, effectively running 1492 separate natural experiments. The top quartile outcome values are preceded by an average 2.03 h of Very Distracting Time.  The bottom quartile outcome values are preceded by an average 1.04 h of Very Distracting Time.  Forward Pearson Correlation Coefficient was 0.354 (p=0.097, 95% CI -0.437 to 1.144 onset delay = 0 hours, duration of action = 168 hours) .  The Reverse Pearson Correlation Coefficient was 0.208 (P=0.097, 95% CI -0.583 to 0.998, onset delay = -0 hours, duration of action = -168 hours). When the Very Distracting Time value is closer to 2.03 h than 1.04 h, the Video Activities value which follows is, on average, 36% percent higher than its typical value.  When the Very Distracting Time value is closer to 1.04 h than 2.03 h, the Video Activities value which follows is 0% lower than its typical value.  Video Activities is 5 h (67% higher) on average after days with around 5 h Very Distracting Time"
          },
          "studyTitle": {
            "type": "string",
            "description": "Ex: N1 Study: Very Distracting Time Predicts Negative Video Activities"
          },
          "studyInvitation": {
            "type": "string",
            "description": "Help us determine if Remeron affects Overall Mood!"
          },
          "studyQuestion": {
            "type": "string",
            "description": "Does Remeron affect Overall Mood?"
          },
          "studyBackground": {
            "type": "string",
            "description": "In order to reduce suffering through the advancement of human knowledge..."
          }
        }
      },
      "StudyVotes": {
        "required": [
          "averageVote",
          "userVote"
        ],
        "type": "object",
        "properties": {
          "averageVote": {
            "type": "number",
            "description": "Average of all user votes with 1 representing an up-vote and 0 representing a down-vote. Ex: 0.9855"
          },
          "userVote": {
            "type": "integer",
            "description": "1 if the current user has up-voted the study and 0 if they down-voted it. Null means no vote. Ex: 1 or 0 or null"
          }
        }
      },
      "TrackingReminderNotificationAction": {
        "required": [
          "action",
          "callback",
          "modifiedValue",
          "title"
        ],
        "type": "object",
        "properties": {
          "action": {
            "type": "string",
            "description": "Ex: track"
          },
          "callback": {
            "type": "string",
            "description": "Ex: trackThreeRatingAction"
          },
          "modifiedValue": {
            "type": "integer",
            "description": "Ex: 3"
          },
          "title": {
            "type": "string",
            "description": "Ex: 3/5"
          },
          "longTitle": {
            "type": "string",
            "description": "Ex: Rate 3/5"
          },
          "shortTitle": {
            "type": "string",
            "description": "Ex: 3"
          }
        }
      },
      "Unit": {
        "required": [
          "abbreviatedName",
          "category",
          "conversionSteps",
          "maximumValue",
          "name",
          "unitCategory"
        ],
        "type": "object",
        "properties": {
          "abbreviatedName": {
            "type": "string",
            "description": "Unit abbreviation"
          },
          "advanced": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "category": {
            "type": "string",
            "description": "Unit category",
            "enum": [
              "Distance",
              "Duration",
              "Energy",
              "Frequency",
              "Miscellany",
              "Pressure",
              "Proportion",
              "Rating",
              "Temperature",
              "Volume",
              "Weight",
              "Count"
            ]
          },
          "categoryId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "categoryName": {
            "type": "string",
            "description": "Ex: Miscellany"
          },
          "conversionSteps": {
            "type": "array",
            "description": "Conversion steps list",
            "items": {
              "$ref": "#/components/schemas/ConversionStep"
            }
          },
          "id": {
            "type": "integer",
            "description": "Ex: 29"
          },
          "manualTracking": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "maximumAllowedValue": {
            "type": "number",
            "description": "The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis.",
            "format": "double"
          },
          "maximumValue": {
            "type": "integer",
            "description": "Ex: 4"
          },
          "minimumAllowedValue": {
            "type": "number",
            "description": "The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis.",
            "format": "double"
          },
          "minimumValue": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "name": {
            "type": "string",
            "description": "Unit name"
          },
          "unitCategory": {
            "$ref": "#/components/schemas/UnitCategory"
          }
        }
      },
      "UnitCategory": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "id"
          },
          "name": {
            "type": "string",
            "description": "Category name"
          },
          "standardUnitAbbreviatedName": {
            "type": "string",
            "description": "Base unit for in which measurements are to be converted to and stored"
          }
        }
      },
      "Variable": {
        "required": [
          "id",
          "name",
          "userId",
          "variableId"
        ],
        "type": "object",
        "properties": {
          "actionArray": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/TrackingReminderNotificationAction"
            }
          },
          "alias": {
            "type": "string",
            "description": "User-Defined Variable Setting:  Alternative display name"
          },
          "availableUnits": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Unit"
            }
          },
          "bestStudyLink": {
            "type": "string",
            "description": "Link to study comparing variable with strongest relationship for user or population"
          },
          "bestStudyCard": {
            "$ref": "#/components/schemas/Card"
          },
          "bestUserStudyLink": {
            "type": "string",
            "description": "Link to study comparing variable with strongest relationship for user"
          },
          "bestUserStudyCard": {
            "$ref": "#/components/schemas/Card"
          },
          "bestPopulationStudyLink": {
            "type": "string",
            "description": "Link to study comparing variable with strongest relationship for population"
          },
          "bestPopulationStudyCard": {
            "$ref": "#/components/schemas/Card"
          },
          "optimalValueMessage": {
            "type": "string",
            "description": "Description of relationship with variable with strongest relationship for user or population"
          },
          "commonOptimalValueMessage": {
            "type": "string",
            "description": "Description of relationship with variable with strongest relationship for population"
          },
          "userOptimalValueMessage": {
            "type": "string",
            "description": "Description of relationship with variable with strongest relationship for user"
          },
          "card": {
            "$ref": "#/components/schemas/Card"
          },
          "causeOnly": {
            "type": "boolean",
            "description": "User-Defined Variable Setting: True indicates that this variable is generally a cause in a causal relationship.  An example of a causeOnly variable would be a variable such as Cloud Cover which would generally not be influenced by the behaviour of the user"
          },
          "charts": {
            "$ref": "#/components/schemas/VariableCharts"
          },
          "chartsLinkDynamic": {
            "type": "string",
            "description": "Ex: https://local.quantimo.do/ionic/Modo/www/#/app/charts/Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29?variableName=Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png"
          },
          "chartsLinkEmail": {
            "type": "string",
            "description": "Ex: mailto:?subject=Check%20out%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20data%21&body=See%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20history%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%0A%0AHave%20a%20great%20day!"
          },
          "chartsLinkFacebook": {
            "type": "string",
            "description": "Ex: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png"
          },
          "chartsLinkGoogle": {
            "type": "string",
            "description": "Ex: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png"
          },
          "chartsLinkStatic": {
            "type": "string",
            "description": "Ex: https://local.quantimo.do/api/v2/charts?variableName=Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Ftreatments.png"
          },
          "chartsLinkTwitter": {
            "type": "string",
            "description": "Ex: https://twitter.com/home?status=Check%20out%20my%20Trader%20Joes%20Bedtime%20Tea%20%2F%20Sleepytime%20Tea%20%28any%20Brand%29%20data%21%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DTrader%2520Joes%2520Bedtime%2520Tea%2520%252F%2520Sleepytime%2520Tea%2520%2528any%2520Brand%2529%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Ftreatments.png%20%40curedao"
          },
          "childCommonTagVariables": {
            "type": "array",
            "description": "Commonly defined for all users. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple.  Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed.  This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "childUserTagVariables": {
            "type": "array",
            "description": "User-Defined Variable Setting: An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple.  Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed.  This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "clientId": {
            "type": "string",
            "description": "Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do"
          },
          "combinationOperation": {
            "type": "string",
            "description": "User-Defined Variable Setting: How to aggregate measurements over time. SUM should be used for things like minutes of exercise.  If you use MEAN for exercise, then a person might exercise more minutes in one day but add separate measurements that were smaller.  So when we are doing correlational analysis, we would think that the person exercised less that day even though they exercised more.  Conversely, we must use MEAN for things such as ratings which cannot be SUMMED.",
            "enum": [
              "MEAN",
              "SUM"
            ]
          },
          "commonAlias": {
            "type": "string",
            "description": "Ex: Anxiety / Nervousness"
          },
          "commonTaggedVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "commonTagVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "createdAt": {
            "type": "string",
            "description": "When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss  datetime format"
          },
          "dataSourceNames": {
            "type": "string",
            "description": "Comma-separated list of source names to limit variables to those sources"
          },
          "dataSources": {
            "type": "array",
            "description": "These are sources of measurements for this variable",
            "items": {
              "$ref": "#/components/schemas/DataSource"
            }
          },
          "description": {
            "type": "string",
            "description": "User-Defined Variable Setting: Ex: Summary to be used in studies."
          },
          "displayName": {
            "type": "string",
            "description": "Ex: Trader Joe's Bedtime Tea"
          },
          "durationOfAction": {
            "type": "integer",
            "description": "The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. Unit: Seconds",
            "format": "int32"
          },
          "durationOfActionInHours": {
            "type": "number",
            "description": "User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay.  Unit: Hours",
            "format": "float"
          },
          "earliestFillingTime": {
            "type": "integer",
            "description": "Earliest filling time",
            "format": "int32"
          },
          "earliestMeasurementTime": {
            "type": "integer",
            "description": "Earliest measurement time",
            "format": "int32"
          },
          "earliestSourceTime": {
            "type": "integer",
            "description": "Earliest source time",
            "format": "int32"
          },
          "errorMessage": {
            "type": "string",
            "description": "Error message from last analysis"
          },
          "experimentEndTime": {
            "type": "string",
            "description": "User-Defined Variable Setting: Latest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss."
          },
          "experimentStartTime": {
            "type": "string",
            "description": "User-Defined Variable Setting: Earliest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss."
          },
          "fillingType": {
            "type": "string",
            "description": "User-Defined Variable Setting: When it comes to analysis to determine the effects of this variable, knowing when it did not occur is as important as knowing when it did occur. For example, if you are tracking a medication, it is important to know when you did not take it, but you do not have to log zero values for all the days when you haven't taken it. Hence, you can specify a filling value (typically 0) to insert whenever data is missing.",
            "enum": [
              "none",
              "zero-filling",
              "value-filling"
            ]
          },
          "fillingValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: When it comes to analysis to determine the effects of this variable, knowing when it did not occur is as important as knowing when it did occur. For example, if you are tracking a medication, it is important to know when you did not take it, but you do not have to log zero values for all the days when you haven't taken it. Hence, you can specify a filling value (typically 0) to insert whenever data is missing.  Unit: User-specified or common.",
            "format": "float"
          },
          "iconIcon": {
            "type": "string",
            "description": "Ex: ion-sad-outline"
          },
          "id": {
            "type": "integer",
            "description": "Ex: 95614"
          },
          "imageUrl": {
            "type": "string"
          },
          "informationalUrl": {
            "type": "string",
            "description": "Ex: https://google.com"
          },
          "ingredientOfCommonTagVariables": {
            "type": "array",
            "description": "Commonly defined for all users. IngredientOf variable measurements will be included in analysis of the ingredient variable.  For instance, a ingredient of the variable Lollipop could be Sugar.  This way you only have to record Lollipop consumption and we can use this data to see how sugar might be affecting you.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "ingredientCommonTagVariables": {
            "type": "array",
            "description": "Commonly defined for all users. IngredientOf variable measurements will be included in analysis of the ingredient variable.  For instance, a ingredient of the variable Lollipop could be Sugar.  This way you only have to record Lollipop consumption and we can use this data to see how sugar might be affecting you.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "ingredientOfUserTagVariables": {
            "type": "array",
            "description": "User-Defined Variable Setting: IngredientOf variable measurements will be included in analysis of the ingredient variable.  For instance, a ingredient of the variable Lollipop could be Sugar.  This way you only have to record Lollipop consumption and we can use this data to see how sugar might be affecting you.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "ingredientUserTagVariables": {
            "type": "array",
            "description": "User-Defined Variable Setting: IngredientOf variable measurements will be included in analysis of the ingredient variable.  For instance, a ingredient of the variable Lollipop could be Sugar.  This way you only have to record Lollipop consumption and we can use this data to see how sugar might be affecting you.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "inputType": {
            "type": "string",
            "description": "Type of input field to show for recording measurements"
          },
          "ionIcon": {
            "type": "string"
          },
          "joinedCommonTagVariables": {
            "type": "array",
            "description": "Commonly defined for all users.  Joining can be used used to merge duplicate variables. For instance, if two variables called Apples (Red Delicious) and Red Delicious Apples are joined, when one of them is analyzed, the measurements for the other will be included as well.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "joinedUserTagVariables": {
            "type": "array",
            "description": "User-Defined Variable Setting: Joining can be used used to merge duplicate variables. For instance, if two variables called Apples (Red Delicious) and Red Delicious Apples are joined, when one of them is analyzed, the measurements for the other will be included as well.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "joinWith": {
            "type": "integer",
            "description": "Duplicate variables. If the variable is joined with some other variable then it is not shown to user in the list of variables",
            "format": "int32"
          },
          "kurtosis": {
            "type": "number",
            "description": "Kurtosis",
            "format": "float"
          },
          "lastProcessedDailyValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 500. Unit: User-specified or common.",
            "format": "double"
          },
          "lastSuccessfulUpdateTime": {
            "type": "string",
            "description": "When this variable or its settings were last updated UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "lastValue": {
            "type": "number",
            "description": "Calculated Statistic: Last measurement value in the common unit or user unit if different. Unit: User-specified or common.",
            "format": "float"
          },
          "latestFillingTime": {
            "type": "integer",
            "description": "Latest filling time",
            "format": "int32"
          },
          "latestMeasurementTime": {
            "type": "integer",
            "description": "Latest measurement time. Format: Unix-time epoch seconds.",
            "format": "int32"
          },
          "latestSourceTime": {
            "type": "integer",
            "description": "Latest source time. Format: Unix-time epoch seconds.",
            "format": "int32"
          },
          "latestUserMeasurementTime": {
            "type": "integer",
            "description": "Ex: 1501383600. Format: Unix-time epoch seconds."
          },
          "latitude": {
            "type": "number",
            "description": "Latitude. Unit: User-specified or common.",
            "format": "float"
          },
          "location": {
            "type": "string",
            "description": "Location"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude",
            "format": "float"
          },
          "manualTracking": {
            "type": "boolean",
            "description": "True if the variable is an emotion or symptom rating that is not typically automatically collected by a device or app."
          },
          "maximumAllowedDailyValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: The maximum allowed value a daily aggregated measurement. Unit: User-specified or common.",
            "format": "float"
          },
          "maximumAllowedValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: The maximum allowed value a single measurement. While you can record a value above this maximum, it will be excluded from the correlation analysis.  Unit: User-specified or common.",
            "format": "float"
          },
          "maximumRecordedDailyValue": {
            "type": "number",
            "description": "Calculated Statistic: Maximum recorded daily value of this variable. Unit: User-specified or common.",
            "format": "float"
          },
          "maximumRecordedValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 1. Unit: User-specified or common.",
            "format": "double"
          },
          "mean": {
            "type": "number",
            "description": "Mean. Unit: User-specified or common.",
            "format": "float"
          },
          "measurementsAtLastAnalysis": {
            "type": "integer",
            "description": "Number of measurements at last analysis",
            "format": "int32"
          },
          "median": {
            "type": "number",
            "description": "Median",
            "format": "float"
          },
          "minimumAllowedValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: The minimum allowed value a single measurement. While you can record a value below this minimum, it will be excluded from the correlation analysis. Unit: User-specified or common",
            "format": "float"
          },
          "minimumAllowedDailyValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: The minimum allowed value a daily aggregated measurement.  For instance, you might set to 100 for steps to keep erroneous 0 daily steps out of the analysis. Unit: User-specified or common.",
            "format": "float"
          },
          "minimumNonZeroValue": {
            "type": "number",
            "description": "User-Defined Variable Setting: The minimum allowed non-zero value a single measurement.  For instance, you might set to 100 mL for steps to keep erroneous 0 daily steps out of the analysis. Unit: User-specified or common.",
            "format": "float"
          },
          "minimumRecordedValue": {
            "type": "number",
            "description": "Minimum recorded value of this variable. Unit: User-specified or common.",
            "format": "float"
          },
          "mostCommonConnectorId": {
            "type": "integer",
            "description": "Ex: 51"
          },
          "mostCommonOriginalUnitId": {
            "type": "integer",
            "description": "Ex: 23"
          },
          "mostCommonUnitId": {
            "type": "integer",
            "description": "Most common Unit ID",
            "format": "int32"
          },
          "mostCommonValue": {
            "type": "number",
            "description": "Calculated Statistic: Most common value. Unit: User-specified or common.",
            "format": "float"
          },
          "name": {
            "type": "string",
            "description": "Ex: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)"
          },
          "numberOfAggregateCorrelationsAsCause": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "numberOfAggregateCorrelationsAsEffect": {
            "type": "integer",
            "description": "Ex: 310"
          },
          "numberOfChanges": {
            "type": "integer",
            "description": "Number of changes",
            "format": "int32"
          },
          "numberOfCorrelations": {
            "type": "integer",
            "description": "Number of correlations for this variable",
            "format": "int32"
          },
          "numberOfCorrelationsAsCause": {
            "type": "integer",
            "description": "numberOfAggregateCorrelationsAsCause plus numberOfUserCorrelationsAsCause"
          },
          "numberOfCorrelationsAsEffect": {
            "type": "integer",
            "description": "numberOfAggregateCorrelationsAsEffect plus numberOfUserCorrelationsAsEffect"
          },
          "numberOfProcessedDailyMeasurements": {
            "type": "integer",
            "description": "Number of processed measurements",
            "format": "int32"
          },
          "numberOfRawMeasurements": {
            "type": "integer",
            "description": "Ex: 295"
          },
          "numberOfTrackingReminders": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "numberOfUniqueDailyValues": {
            "type": "number",
            "description": "Number of unique daily values",
            "format": "float"
          },
          "numberOfUniqueValues": {
            "type": "integer",
            "description": "Ex: 2"
          },
          "numberOfUserCorrelationsAsCause": {
            "type": "integer",
            "description": "Ex: 115"
          },
          "numberOfUserCorrelationsAsEffect": {
            "type": "integer",
            "description": "Ex: 29014"
          },
          "numberOfUserVariables": {
            "type": "integer",
            "description": "Ex: 2"
          },
          "onsetDelay": {
            "type": "integer",
            "description": "The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes.",
            "format": "int32"
          },
          "onsetDelayInHours": {
            "type": "number",
            "description": "User-Defined Variable Setting: The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes.",
            "format": "double"
          },
          "outcome": {
            "type": "boolean",
            "description": "User-Defined Variable Setting: True for variables for which a human would generally want to identify the influencing factors. These include symptoms of illness, physique, mood, cognitive performance, etc.  Generally correlation calculations are only performed on outcome variables"
          },
          "outcomeOfInterest": {
            "type": "boolean",
            "description": "Do you want to receive updates on newly discovered factors influencing this variable?"
          },
          "parentCommonTagVariables": {
            "type": "array",
            "description": "Commonly defined for all users.  An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple.  Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed.  This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "parentUserTagVariables": {
            "type": "array",
            "description": "User-defined. An example of a parent category variable would be Fruit when tagged with the child sub-type variables Apple.  Child variable (Apple) measurements will be included when the parent category (Fruit) is analyzed.  This allows us to see how Fruit consumption might be affecting without having to record both Fruit and Apple intake.",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "pngPath": {
            "type": "string",
            "description": "Ex: img/variable_categories/treatments.png"
          },
          "pngUrl": {
            "type": "string",
            "description": "Ex: https://web.quantimo.do/img/variable_categories/treatments.png"
          },
          "predictorOfInterest": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "price": {
            "type": "number",
            "description": "Ex: 95.4",
            "format": "double"
          },
          "productUrl": {
            "type": "string",
            "description": "Link to associated product for purchase"
          },
          "public": {
            "type": "boolean",
            "description": "Should this variable show up in automcomplete searches for users who do not already have measurements for it?"
          },
          "question": {
            "type": "string",
            "description": "Ex: How is your overall mood?"
          },
          "longQuestion": {
            "type": "string",
            "description": "Ex: How is your overall mood on a scale of 1 to 5??"
          },
          "rawMeasurementsAtLastAnalysis": {
            "type": "integer",
            "description": "Ex: 131"
          },
          "secondMostCommonValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 1. Unit: User-specified or common.",
            "format": "double"
          },
          "secondToLastValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 250. Unit: User-specified or common.",
            "format": "double"
          },
          "shareUserMeasurements": {
            "type": "boolean",
            "description": "Would you like to make your measurements publicly visible?"
          },
          "skewness": {
            "type": "number",
            "description": "Skewness",
            "format": "float"
          },
          "standardDeviation": {
            "type": "number",
            "description": "Standard deviation Ex: 0.46483219855434",
            "format": "double"
          },
          "status": {
            "type": "string",
            "description": "status"
          },
          "subtitle": {
            "type": "string",
            "description": "Based on sort filter and can be shown beneath variable name on search list"
          },
          "svgUrl": {
            "type": "string",
            "description": "Ex: https://web.quantimo.do/img/variable_categories/treatments.svg"
          },
          "thirdMostCommonValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 6. Unit: User-specified or common.",
            "format": "double"
          },
          "thirdToLastValue": {
            "type": "number",
            "description": "Calculated Statistic: Ex: 250. Unit: User-specified or common.",
            "format": "double"
          },
          "trackingInstructions": {
            "type": "string",
            "description": "HTML instructions for tracking"
          },
          "trackingInstructionsCard": {
            "$ref": "#/components/schemas/Card"
          },
          "unit": {
            "$ref": "#/components/schemas/Unit"
          },
          "unitAbbreviatedName": {
            "type": "string",
            "description": "Ex: count"
          },
          "unitCategoryId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "unitCategoryName": {
            "type": "string",
            "description": "Ex: Miscellany"
          },
          "unitId": {
            "type": "integer",
            "description": "ID of unit to use for this variable",
            "format": "int32"
          },
          "unitName": {
            "type": "string",
            "description": "User-Defined Variable Setting: Count"
          },
          "upc": {
            "type": "string",
            "description": "Universal product code or similar"
          },
          "updated": {
            "type": "integer",
            "description": "updated",
            "format": "int32"
          },
          "updatedAt": {
            "type": "string",
            "description": "When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format"
          },
          "updatedTime": {
            "type": "string",
            "description": "Ex: 2017-07-30 14:58:26"
          },
          "userId": {
            "type": "integer",
            "description": "User ID",
            "format": "int32"
          },
          "userTaggedVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "userTagVariables": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "userVariableUnitAbbreviatedName": {
            "type": "string",
            "description": "Ex: count"
          },
          "userVariableUnitCategoryId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "userVariableUnitCategoryName": {
            "type": "string",
            "description": "Ex: Miscellany"
          },
          "userVariableUnitId": {
            "type": "integer",
            "description": "Ex: 23"
          },
          "userVariableUnitName": {
            "type": "string",
            "description": "Ex: Count"
          },
          "variableCategory": {
            "$ref": "#/components/schemas/VariableCategory"
          },
          "joinedVariables": {
            "type": "array",
            "description": "Array of Variables that are joined with this Variable",
            "items": {
              "$ref": "#/components/schemas/Variable"
            }
          },
          "valence": {
            "type": "string",
            "description": "Valence indicates what type of buttons should be used when recording measurements for this variable. positive - Face buttons with the happiest face equating to a 5/5 rating where higher is better like Overall Mood. negative - Face buttons with happiest face equating to a 1/5 rating where lower is better like Headache Severity. numeric - Just 1 to 5 numeric buttons for neutral variables. "
          },
          "variableCategoryId": {
            "type": "integer",
            "description": "Ex: 6"
          },
          "variableCategoryName": {
            "type": "string",
            "description": "User-Defined Variable Setting: Variable category like Emotions, Sleep, Physical Activities, Treatments, Symptoms, etc.",
            "enum": [
              "Activity",
              "Books",
              "Causes of Illness",
              "Cognitive Performance",
              "Conditions",
              "Emotions",
              "Environment",
              "Foods",
              "Goals",
              "Locations",
              "Miscellaneous",
              "Movies and TV",
              "Music",
              "Nutrients",
              "Payments",
              "Physical Activities",
              "Physique",
              "Sleep",
              "Social Interactions",
              "Software",
              "Symptoms",
              "Treatments",
              "Vital Signs"
            ]
          },
          "variableId": {
            "type": "integer",
            "description": "Ex: 96380"
          },
          "variableName": {
            "type": "string",
            "description": "Ex: Sleep Duration"
          },
          "variance": {
            "type": "number",
            "description": "Statistic: Ex: 115947037.40816",
            "format": "double"
          },
          "wikipediaTitle": {
            "type": "string",
            "description": "User-Defined Variable Setting: You can help to improve the studies by pasting the title of the most appropriate Wikipedia article for this variable"
          }
        }
      },
      "VariableCategory": {
        "required": [
          "name"
        ],
        "type": "object",
        "properties": {
          "appType": {
            "type": "string",
            "description": "Ex: mood"
          },
          "causeOnly": {
            "type": "boolean",
            "description": "Ex: false"
          },
          "combinationOperation": {
            "type": "string",
            "description": "Ex: MEAN"
          },
          "createdTime": {
            "type": "string",
            "description": "UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "unitAbbreviatedName": {
            "type": "string",
            "description": "Ex: /5"
          },
          "unitId": {
            "type": "integer",
            "description": "Ex: 10"
          },
          "durationOfAction": {
            "type": "integer",
            "description": "User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay.  Unit: Seconds"
          },
          "fillingValue": {
            "type": "integer",
            "description": "Ex: -1. Unit: Variable category default unit."
          },
          "helpText": {
            "type": "string",
            "description": "Ex: What emotion do you want to rate?"
          },
          "id": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "imageUrl": {
            "type": "string",
            "description": "Ex: https://static.quantimo.do/img/variable_categories/theatre_mask-96.png"
          },
          "ionIcon": {
            "type": "string",
            "description": "Ex: ion-happy-outline"
          },
          "manualTracking": {
            "type": "boolean",
            "description": "Ex: true"
          },
          "maximumAllowedValue": {
            "type": "string",
            "description": "Unit: Variable category default unit."
          },
          "measurementSynonymSingularLowercase": {
            "type": "string",
            "description": "Ex: rating"
          },
          "minimumAllowedValue": {
            "type": "string",
            "description": "Unit: Variable category default unit."
          },
          "moreInfo": {
            "type": "string",
            "description": "Ex: Do you have any emotions that fluctuate regularly?  If so, add them so I can try to determine which factors are influencing them."
          },
          "name": {
            "type": "string",
            "description": "Category name"
          },
          "onsetDelay": {
            "type": "integer",
            "description": "Ex: 0"
          },
          "outcome": {
            "type": "boolean",
            "description": "Ex: true"
          },
          "pngPath": {
            "type": "string",
            "description": "Ex: img/variable_categories/emotions.png"
          },
          "pngUrl": {
            "type": "string",
            "description": "Ex: https://web.quantimo.do/img/variable_categories/emotions.png"
          },
          "public": {
            "type": "boolean",
            "description": "Ex: true"
          },
          "svgPath": {
            "type": "string",
            "description": "Ex: img/variable_categories/emotions.svg"
          },
          "svgUrl": {
            "type": "string",
            "description": "Ex: https://web.quantimo.do/img/variable_categories/emotions.svg"
          },
          "updated": {
            "type": "integer",
            "description": "Ex: 1"
          },
          "updatedTime": {
            "type": "string",
            "description": "UTC ISO 8601 YYYY-MM-DDThh:mm:ss"
          },
          "variableCategoryName": {
            "type": "string",
            "description": "Ex: Emotions, Treatments, Symptoms...",
            "enum": [
              "Activity",
              "Books",
              "Causes of Illness",
              "Cognitive Performance",
              "Conditions",
              "Emotions",
              "Environment",
              "Foods",
              "Goals",
              "Locations",
              "Miscellaneous",
              "Movies and TV",
              "Music",
              "Nutrients",
              "Payments",
              "Physical Activities",
              "Physique",
              "Sleep",
              "Social Interactions",
              "Software",
              "Symptoms",
              "Treatments",
              "Vital Signs"
            ]
          },
          "variableCategoryNameSingular": {
            "type": "string",
            "description": "Ex: Emotion"
          }
        }
      },
      "VariableCharts": {
        "type": "object",
        "properties": {
          "hourlyColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "monthlyColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "distributionColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "weekdayColumnChart": {
            "$ref": "#/components/schemas/Chart"
          },
          "lineChartWithoutSmoothing": {
            "$ref": "#/components/schemas/Chart"
          },
          "lineChartWithSmoothing": {
            "$ref": "#/components/schemas/Chart"
          }
        },
        "description": "An object with various chart properties each property contain and svg and Highcharts configuration"
      }
    },
    "parameters": {
      "causeVariableNameParam": {
        "name": "causeVariableName",
        "in": "query",
        "description": "Deprecated: Name of the hypothetical predictor variable.  Ex: Sleep Duration",
        "schema": {
          "type": "string"
        }
      },
      "causeVariableIdParam": {
        "name": "causeVariableId",
        "in": "query",
        "description": "Variable id of the hypothetical predictor variable.  Ex: 1398",
        "schema": {
          "type": "integer"
        }
      },
      "predictorVariableNameParam": {
        "name": "predictorVariableName",
        "in": "query",
        "description": "Name of the hypothetical predictor variable.  Ex: Sleep Duration",
        "schema": {
          "type": "string"
        }
      },
      "clientIdParam": {
        "name": "clientId",
        "in": "query",
        "description": "Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do",
        "schema": {
          "type": "string"
        }
      },
      "effectVariableNameParam": {
        "name": "effectVariableName",
        "in": "query",
        "description": "Deprecated: Name of the outcome variable of interest.  Ex: Overall Mood",
        "schema": {
          "type": "string"
        }
      },
      "effectVariableIdParam": {
        "name": "effectVariableId",
        "in": "query",
        "description": "Variable id of the outcome variable of interest.  Ex: 1398",
        "schema": {
          "type": "integer"
        }
      },
      "outcomeVariableNameParam": {
        "name": "outcomeVariableName",
        "in": "query",
        "description": "Name of the outcome variable of interest.  Ex: Overall Mood",
        "schema": {
          "type": "string"
        }
      },
      "includeChartsParam": {
        "name": "includeCharts",
        "in": "query",
        "description": "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.",
        "schema": {
          "type": "boolean"
        }
      },
      "recalculate": {
        "name": "recalculate",
        "in": "query",
        "description": "Recalculate instead of using cached analysis",
        "schema": {
          "type": "boolean"
        }
      },
      "studyClientIdParam": {
        "name": "studyId",
        "in": "query",
        "description": "Client id for the study you want",
        "schema": {
          "type": "string"
        }
      },
      "userIdParam": {
        "name": "userId",
        "in": "query",
        "description": "User's id",
        "schema": {
          "type": "number"
        }
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "curedao_oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.quantimo.do/api/v1/oauth/authorize",
            "tokenUrl": "https://app.quantimo.do/api/v1/oauth/token",
            "scopes": {
              "basic": "Allows you to read user info (display name, email, etc)",
              "readmeasurements": "Allows one to read a user's measurements",
              "writemeasurements": "Allows you to write user measurements"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 98,
      "1": 59,
      "2": 203,
      "3": 63,
      "4": 174,
      "5": 1,
      "6": 81,
      "7": 0,
      "8": 69,
      "9": 170,
      "10": 238,
      "11": 41
    }
  }
}
```