---
title: "Get correlations"
method: GET
path: "/v3/correlations"
tags: ["analytics"]
---

# Get correlations

`GET /v3/correlations`

Get a list of correlations that can be used to display top predictors of a given outcome like mood, for instance.

## Query parameters

- `causeVariableName` string
- `effectVariableName` string
- `causeVariableId` integer
- `effectVariableId` integer
- `predictorVariableName` string
- `outcomeVariableName` string
- `sort` string
- `limit` integer
- `offset` integer
- `userId` number
- `correlationCoefficient` string
- `updatedAt` string
- `outcomesOfInterest` boolean
- `clientId` string
- `commonOnly` boolean

## Response `200`

Successful operation

- GetCorrelationsResponse
  - `data` GetCorrelationsDataResponse
    - `correlations` Correlation[], required
      - `averageDailyHighCause` number, double — Ex: 4.19
      - `averageDailyLowCause` number, double — Ex: 1.97
      - `averageEffect` number, double — Ex: 3.0791054117396
      - `averageEffectFollowingHighCause` number, double — Ex: 3.55
      - `averageEffectFollowingLowCause` number, double — Ex: 2.65
      - `averageForwardPearsonCorrelationOverOnsetDelays` number, double — Ex: 0.396
      - `averageReversePearsonCorrelationOverOnsetDelays` number, double — Ex: 0.453667
      - `averageVote` number — Ex: 0.9855
      - `causeChanges` integer — Ex: 164
      - `causeDataSource` DataSource
        - `affiliate` boolean, required — Ex: true
        - `backgroundColor` string — Background color HEX code that matches the icon
        - `buttons` Button[]
          - `accessibilityText` string — Ex: connect
          - `action` object — Action data
          - `additionalInformation` string — Ex: connect
          - `color` string — Ex: #f2f2f2
          - `confirmationText` string — Text to show user before executing functionName
          - `functionName` string — Name of function to call
          - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
          - `html` string — Ex: connect
          - `id` string — HTML element id
          - `image` string — Ex: https://image.jpg
          - `ionIcon` string — Ex: ion-refresh
          - `link` string, required — Ex: https://local.quantimo.do
          - `stateName` string — State to go to
          - `stateParams` object — Data to provide to the state
          - `successToastText` string — Text to show user after executing functionName
          - `successAlertTitle` string — Text to show user after executing functionName
          - `successAlertBody` string — Text to show user after executing functionName
          - `text` string, required — Ex: Connect
          - `tooltip` string — Ex: This is a tooltip
          - `webhookUrl` string — Post here on button click
        - `card` Card
          - `actionSheetButtons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `avatar` string — Smaller square image
          - `avatarCircular` string — Smaller circular image
          - `backgroundColor` string — Ex: #f2f2f2
          - `buttons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `buttonsSecondary` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `content` string — Ex: Content
          - `headerTitle` string — Ex: Title
          - `html` string — HTML for the entire card.
          - `htmlContent` string — Ex: <div>Content</div>
          - `id` string, required — HTML element id
          - `image` string — Larger image of variable dimensions
          - `inputFields` InputField[]
            - `displayName` string, required
            - `helpText` string
            - `hint` string
            - `icon` string
            - `id` string — HTML element id
            - `image` string
            - `key` string
            - `labelLeft` string
            - `labelRight` string
            - `link` string
            - `maxLength` integer
            - `maxValue` number
            - `minLength` integer
            - `minValue` number
            - `options` string[] — Selector list options
            - `placeholder` string — Ex: Title
            - `postUrl` string
            - `required` boolean
            - `show` boolean — Ex: Title
            - `submitButton` Button
              - …
            - `type` 'check_box' | 'date' | 'email' | 'number' | 'postal_code' | 'select_option' | 'string' | 'switch' | 'text_area' | 'unit' | 'variable_category', required — Ex: Title
            - `validationPattern` string — See http://html5pattern.com/ for examples
            - `value` string
          - `ionIcon` string — Ex: ion-refresh
          - `link` string — A link to a web page or something. Not much more to say about that.
          - `parameters` object — Key value pairs derived from user input fields, button clicks, or preset defaults
          - `relatedCards` Card[]
          - `selectedButton` Button
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `sharingBody` string — Ex: sharingBody
          - `sharingButtons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `sharingTitle` string — Ex: sharingTitle
          - `subHeader` string — Ex: subTitle
          - `subTitle` string — Ex: subTitle
          - `title` string — Ex: Title
        - `clientId` string — Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do
        - `connected` boolean — True if the authenticated user has this connector enabled
        - `connectError` string — Ex: Your token is expired. Please re-connect
        - `connectInstructions` ConnectInstructions
          - `parameters` object[] — Create a form with these fields and post the key and user submitted value to the provided connect url
          - `url` string, required — URL to open to connect
          - `usePopup` boolean — True if should open auth window in popup
        - `connectorId` integer — Ex: 8
        - `connectStatus` string — Ex: CONNECTED
        - `count` integer — Number of measurements from this source or number of users who have measurements from this source
        - `createdAt` string — Ex: 2000-01-01 00:00:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `connectorClientId` string, required — Ex: ba7d0c12432650e23b3ce924ae2d21e2ff59e7e4e28650759633700af7ed0a30
        - `defaultVariableCategoryName` string, required — Ex: Foods
        - `displayName` string, required — Ex: CureDAO
        - `enabled` integer, required — Ex: 0
        - `getItUrl` string, required — Ex: https://curedao.org
        - `id` integer, required — Ex: 72
        - `image` string, required — Ex: https://web.quantimo.do/img/logos/curedao-logo-qm-rainbow-200-200.png
        - `imageHtml` string, required — 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` string — Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `lastUpdate` integer — Epoch timestamp of last sync
        - `linkedDisplayNameHtml` string, required — Ex: <a href="https://curedao.org">CureDAO</a>
        - `longDescription` string, required — 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` string — Ex: Got 412 new measurements on 2017-07-31 10:10:34
        - `mobileConnectMethod` string — Mobile connect method: webview, cordova, google, spreadsheet, or ip
        - `name` string, required — Ex: curedao
        - `platforms` string[] — Platforms (chrome, android, ios, web) that you can connect on.
        - `premium` boolean — True if connection requires upgrade
        - `scopes` string[] — Required connector scopes
        - `shortDescription` string, required — Ex: Tracks anything
        - `spreadsheetUploadLink` string — URL to POST a spreadsheet to (if available for this data source)
        - `totalMeasurementsInLastUpdate` integer — Number of measurements obtained during latest update
        - `updatedAt` string — Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `updateRequestedAt` string — Ex: 2017-07-18 05:16:31 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `updateStatus` string — Ex: UPDATED
        - `userId` integer — Ex: 230
      - `causeUserVariableShareUserMeasurements` integer — Ex: 1
      - `causeVariableCategoryId` integer — Ex: 6
      - `causeVariableCategoryName` string — Ex: Sleep
      - `causeVariableCombinationOperation` string — Ex: MEAN
      - `causeVariableUnitAbbreviatedName` string — Ex: /5
      - `causeVariableId` integer — Ex: 1448
      - `causeVariableMostCommonConnectorId` integer — Ex: 6
      - `causeVariableName` string, required — Ex: Sleep Quality
      - `confidenceInterval` number, double — Ex: 0.14344467795996
      - `confidenceLevel` string — Ex: high
      - `correlationCoefficient` number, double — Ex: 0.538
      - `correlationIsContradictoryToOptimalValues` boolean — Ex: false
      - `createdAt` string — Ex: 2016-12-28 20:47:30 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
      - `criticalTValue` number, double — Calculated Statistic: Ex: 1.646
      - `direction` string — Ex: higher
      - `durationOfAction` integer — 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` number, float — 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
      - `degreesOfFreedom` integer — Ex: 200
      - `effectNumberOfProcessedDailyMeasurements` integer — Ex: 145
      - `error` string — Ex: optimalPearsonProduct is not defined
      - `effectChanges` integer — Ex: 193
      - `effectDataSource` DataSource
        - `affiliate` boolean, required — Ex: true
        - `backgroundColor` string — Background color HEX code that matches the icon
        - `buttons` Button[]
          - `accessibilityText` string — Ex: connect
          - `action` object — Action data
          - `additionalInformation` string — Ex: connect
          - `color` string — Ex: #f2f2f2
          - `confirmationText` string — Text to show user before executing functionName
          - `functionName` string — Name of function to call
          - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
          - `html` string — Ex: connect
          - `id` string — HTML element id
          - `image` string — Ex: https://image.jpg
          - `ionIcon` string — Ex: ion-refresh
          - `link` string, required — Ex: https://local.quantimo.do
          - `stateName` string — State to go to
          - `stateParams` object — Data to provide to the state
          - `successToastText` string — Text to show user after executing functionName
          - `successAlertTitle` string — Text to show user after executing functionName
          - `successAlertBody` string — Text to show user after executing functionName
          - `text` string, required — Ex: Connect
          - `tooltip` string — Ex: This is a tooltip
          - `webhookUrl` string — Post here on button click
        - `card` Card
          - `actionSheetButtons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `avatar` string — Smaller square image
          - `avatarCircular` string — Smaller circular image
          - `backgroundColor` string — Ex: #f2f2f2
          - `buttons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `buttonsSecondary` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `content` string — Ex: Content
          - `headerTitle` string — Ex: Title
          - `html` string — HTML for the entire card.
          - `htmlContent` string — Ex: <div>Content</div>
          - `id` string, required — HTML element id
          - `image` string — Larger image of variable dimensions
          - `inputFields` InputField[]
            - `displayName` string, required
            - `helpText` string
            - `hint` string
            - `icon` string
            - `id` string — HTML element id
            - `image` string
            - `key` string
            - `labelLeft` string
            - `labelRight` string
            - `link` string
            - `maxLength` integer
            - `maxValue` number
            - `minLength` integer
            - `minValue` number
            - `options` string[] — Selector list options
            - `placeholder` string — Ex: Title
            - `postUrl` string
            - `required` boolean
            - `show` boolean — Ex: Title
            - `submitButton` Button
              - …
            - `type` 'check_box' | 'date' | 'email' | 'number' | 'postal_code' | 'select_option' | 'string' | 'switch' | 'text_area' | 'unit' | 'variable_category', required — Ex: Title
            - `validationPattern` string — See http://html5pattern.com/ for examples
            - `value` string
          - `ionIcon` string — Ex: ion-refresh
          - `link` string — A link to a web page or something. Not much more to say about that.
          - `parameters` object — Key value pairs derived from user input fields, button clicks, or preset defaults
          - `relatedCards` Card[]
          - `selectedButton` Button
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `sharingBody` string — Ex: sharingBody
          - `sharingButtons` Button[]
            - `accessibilityText` string — Ex: connect
            - `action` object — Action data
            - `additionalInformation` string — Ex: connect
            - `color` string — Ex: #f2f2f2
            - `confirmationText` string — Text to show user before executing functionName
            - `functionName` string — Name of function to call
            - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
            - `html` string — Ex: connect
            - `id` string — HTML element id
            - `image` string — Ex: https://image.jpg
            - `ionIcon` string — Ex: ion-refresh
            - `link` string, required — Ex: https://local.quantimo.do
            - `stateName` string — State to go to
            - `stateParams` object — Data to provide to the state
            - `successToastText` string — Text to show user after executing functionName
            - `successAlertTitle` string — Text to show user after executing functionName
            - `successAlertBody` string — Text to show user after executing functionName
            - `text` string, required — Ex: Connect
            - `tooltip` string — Ex: This is a tooltip
            - `webhookUrl` string — Post here on button click
          - `sharingTitle` string — Ex: sharingTitle
          - `subHeader` string — Ex: subTitle
          - `subTitle` string — Ex: subTitle
          - `title` string — Ex: Title
        - `clientId` string — Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do
        - `connected` boolean — True if the authenticated user has this connector enabled
        - `connectError` string — Ex: Your token is expired. Please re-connect
        - `connectInstructions` ConnectInstructions
          - `parameters` object[] — Create a form with these fields and post the key and user submitted value to the provided connect url
          - `url` string, required — URL to open to connect
          - `usePopup` boolean — True if should open auth window in popup
        - `connectorId` integer — Ex: 8
        - `connectStatus` string — Ex: CONNECTED
        - `count` integer — Number of measurements from this source or number of users who have measurements from this source
        - `createdAt` string — Ex: 2000-01-01 00:00:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `connectorClientId` string, required — Ex: ba7d0c12432650e23b3ce924ae2d21e2ff59e7e4e28650759633700af7ed0a30
        - `defaultVariableCategoryName` string, required — Ex: Foods
        - `displayName` string, required — Ex: CureDAO
        - `enabled` integer, required — Ex: 0
        - `getItUrl` string, required — Ex: https://curedao.org
        - `id` integer, required — Ex: 72
        - `image` string, required — Ex: https://web.quantimo.do/img/logos/curedao-logo-qm-rainbow-200-200.png
        - `imageHtml` string, required — 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` string — Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `lastUpdate` integer — Epoch timestamp of last sync
        - `linkedDisplayNameHtml` string, required — Ex: <a href="https://curedao.org">CureDAO</a>
        - `longDescription` string, required — 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` string — Ex: Got 412 new measurements on 2017-07-31 10:10:34
        - `mobileConnectMethod` string — Mobile connect method: webview, cordova, google, spreadsheet, or ip
        - `name` string, required — Ex: curedao
        - `platforms` string[] — Platforms (chrome, android, ios, web) that you can connect on.
        - `premium` boolean — True if connection requires upgrade
        - `scopes` string[] — Required connector scopes
        - `shortDescription` string, required — Ex: Tracks anything
        - `spreadsheetUploadLink` string — URL to POST a spreadsheet to (if available for this data source)
        - `totalMeasurementsInLastUpdate` integer — Number of measurements obtained during latest update
        - `updatedAt` string — Ex: 2017-07-31 10:10:34 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `updateRequestedAt` string — Ex: 2017-07-18 05:16:31 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
        - `updateStatus` string — Ex: UPDATED
        - `userId` integer — Ex: 230
      - `effectSize` string — Ex: moderately positive
      - `effectUnit` string — Ex: /5
      - `effectUserVariableShareUserMeasurements` integer — Ex: 1
      - `effectVariableCategoryId` integer — Ex: 1
      - `effectVariableCategoryName` string — Ex: Emotions
      - `effectVariableCombinationOperation` string — Ex: MEAN
      - `effectVariableCommonAlias` string — Ex: Mood_(psychology)
      - `effectVariableUnitAbbreviatedName` string — Ex: /5
      - `effectVariableUnitId` integer — Ex: 10
      - `effectVariableUnitName` string — Ex: 1 to 5 Rating
      - `effectVariableId` integer — Ex: 1398
      - `effectVariableMostCommonConnectorId` integer — Ex: 10
      - `effectVariableName` string, required — Ex: Overall Mood
      - `experimentEndTime` string — Ex: 2014-07-30 12:50:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
      - `experimentStartTime` string — Ex: 2012-05-06 21:15:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
      - `forwardSpearmanCorrelationCoefficient` number, double — Ex: 0.528359
      - `numberOfPairs` integer — Ex: 298
      - `onsetDelay` integer — Ex: 0
      - `onsetDelayInHours` number, float — Ex: 0
      - `onsetDelayWithStrongestPearsonCorrelation` integer — Ex: -86400
      - `onsetDelayWithStrongestPearsonCorrelationInHours` number, float — Ex: -24
      - `optimalPearsonProduct` number, double — Ex: 0.68582816186982
      - `outcomeFillingValue` integer — User-Defined Variable Setting: Ex: -1. Unit: User-specified or common.
      - `outcomeMaximumAllowedValue` number, double — User-Defined Variable Setting: Ex: 23. Unit: User-specified or common.
      - `outcomeMinimumAllowedValue` number, double — User-Defined Variable Setting: Ex: 0.1. Unit: User-specified or common.
      - `pearsonCorrelationWithNoOnsetDelay` number, double — Ex: 0.477
      - `predictivePearsonCorrelation` number, double — Ex: 0.538
      - `predictivePearsonCorrelationCoefficient` number, double — Ex: 0.538
      - `predictorDataSources` string — Ex: RescueTime
      - `predictorFillingValue` integer — Ex: -1. Unit: User-specified or common.
      - `predictorMaximumAllowedValue` number, double — Ex: 200. Unit: User-specified or common.
      - `predictorMinimumAllowedValue` number, double — Ex: 30. Unit: User-specified or common.
      - `predictsHighEffectChange` integer — Ex: 17. Unit: User-specified or common.
      - `predictsLowEffectChange` integer — Ex: -11. Unit: User-specified or common.
      - `pValue` number, double — Ex: 0.39628900511586
      - `qmScore` number, double — Ex: 0.528
      - `reversePearsonCorrelationCoefficient` number, double — Ex: 0.01377184270977
      - `shareUserMeasurements` boolean — Would you like to make this study publicly visible?
      - `sharingDescription` string — Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood
      - `sharingTitle` string — Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood
      - `significantDifference` boolean — Ex: 1
      - `statisticalSignificance` number, double — Ex: 0.9813
      - `strengthLevel` string — Ex: moderate
      - `strongestPearsonCorrelationCoefficient` number, double — Ex: 0.613
      - `studyHtml` StudyHtml
        - `chartHtml` string, required — Embeddable chart html
        - `downloadButtonsHtml` string — Play Store, App Store, Chrome Web Store
        - `fullPageWithHead` string — Embeddable study including HTML head section charts. Modifiable css classes are study-title, study-section-header, study-section-body
        - `fullStudyHtml` string, required — Embeddable study text html including charts. Modifiable css classes are study-title, study-section-header, study-section-body
        - `fullStudyHtmlWithCssStyles` string — Embeddable study html including charts and css styling
        - `participantInstructionsHtml` string — Instructions for study participation
        - `statisticsTableHtml` string — Embeddable table with statistics
        - `studyAbstractHtml` string — Text summary
        - `studyHeaderHtml` string — Title, study image, abstract with CSS styling
        - `studyImageHtml` string — PNG image
        - `studyMetaHtml` string — Facebook, Twitter, Google+
        - `studyTextHtml` string — Formatted study text sections
        - `socialSharingButtonHtml` string
        - `studySummaryBoxHtml` string
      - `studyImages` StudyImages
        - `causeVariableImageUrl` string — Ex: https://static.quantimo.do/img/variable_categories/sleeping_in_bed-96.png
        - `causeVariableIonIcon` string — Ex: ion-ios-cloudy-night-outline
        - `effectVariableImageUrl` string — Ex: https://static.quantimo.do/img/variable_categories/theatre_mask-96.png
        - `effectVariableIonIcon` string — Ex: ion-happy-outline
        - `gaugeImage` string, required — Ex: https://s3.amazonaws.com/curedao-docs/images/gauge-moderately-positive-relationship.png
        - `gaugeImageSquare` string, required — Ex: https://s3.amazonaws.com/curedao-docs/images/gauge-moderately-positive-relationship-200-200.png
        - `gaugeSharingImageUrl` string — Image with gauge and category images
        - `imageUrl` string, required — Ex: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-moderately-positive-relationship_sleep_emotions_logo_background.png
        - `robotSharingImageUrl` string — Image with robot and category images
        - `avatar` string — Avatar of the principal investigator
      - `studyLinks` StudyLinks
        - `studyJoinLink` string — Share this link with potential study participants
        - `studyLinkEmail` string, required — 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` string, required — 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` string, required — 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` string, required — Ex: https://local.quantimo.do/api/v2/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230
        - `studyLinkDynamic` string, required — Ex: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230
        - `studyLinkTwitter` string, required — 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
      - `studyText` StudyText
        - `averageEffectFollowingHighCauseExplanation` string — Ex: Overall Mood is 3.55/5 (15% higher) on average after days with around 4.19/5 Sleep Quality
        - `averageEffectFollowingLowCauseExplanation` string — Ex: Overall Mood is 2.65/5 (14% lower) on average after days with around 1.97/5 Sleep Quality
        - `valuePredictingHighOutcomeExplanation` string — Ex: Overall Mood, on average, 17% higher after around 4.14/5 Sleep Quality
        - `valuePredictingLowOutcomeExplanation` string — Ex: Overall Mood, on average, 11% lower after around 3.03/5 Sleep Quality
        - `dataAnalysis` string — 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` string — 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` string — 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` string — 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` string — Ex: Sleep Quality Predicts Higher Overall Mood
        - `lastCauseAndOptimalValueSentence` string — Ex: Sleep Quality Predicts Higher Overall Mood
        - `lastCauseDailyValueSentence` string — Ex: Sleep Quality Predicts Higher Overall Mood
        - `optimalDailyValueSentence` string — Ex: Sleep Quality Predicts Higher Overall Mood
        - `participantInstructions` string — Instructions for study participation
        - `predictorExplanation` string — Ex: Sleep Quality Predicts Higher Overall Mood
        - `significanceExplanation` string — 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` string, required — 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` string, required — 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` string, required — Ex: As with any human experiment, it was impossible to control for all potentially confounding variables. Correlation does not necessarily imply correlation. We can never know for sure if one factor is definitely the cause of an outcome. However, lack of correlation definitely implies the lack of a causal relationship. Hence, we can with great confidence rule out non-existent relationships. For instance, if we discover no relationship between mood and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship. <br> <br> 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. 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. The list of the criteria is as follows: <br> 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. <br> 2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect. <br> 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. <br> 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). <br> 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. <br> 6. Plausibility: A plausible mechanism between cause and effect is helpful. <br> 7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect. <br> 8. Experiment: "Occasionally it is possible to appeal to experimental evidence". <br> 9. Analogy: The effect of similar factors may be considered. <br> <br> 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, one will likely increase their banana intake. Due to the fact that this correlation is spurious, it is unlikely that you will see a continued and persistent corresponding increase in mood. So over time, the spurious correlation will 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` string, required — 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` string, required — 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` string, required — Ex: N1 Study: Very Distracting Time Predicts Negative Video Activities
        - `studyInvitation` string — Help us determine if Remeron affects Overall Mood!
        - `studyQuestion` string — Does Remeron affect Overall Mood?
        - `studyBackground` string — In order to reduce suffering through the advancement of human knowledge...
      - `tValue` number, double — Ex: 9.6986079652717
      - `updatedAt` string — Ex: 2017-05-06 15:40:38 UTC ISO 8601 YYYY-MM-DDThh:mm:ss
      - `userId` integer — Ex: 230
      - `userVote` integer — Ex: 1
      - `valuePredictingHighOutcome` number, double — Ex: 4.14
      - `valuePredictingLowOutcome` number, double — Ex: 3.03
      - `outcomeDataSources` string — Sources used to collect data for the outcome variable
      - `principalInvestigator` string — Mike Sinn
      - `reverseCorrelation` number — Correlation when cause and effect are reversed. For any causal relationship, the forward correlation should exceed the reverse correlation.
      - `averagePearsonCorrelationCoefficientOverOnsetDelays` number, float — Ex:
      - `causeNumberOfRawMeasurements` integer — Ex: 14764
      - `correlationsOverDurationsOfAction` Correlation[] — Correlations calculated with various duration of action hyper-parameters
      - `correlationsOverOnsetDelays` Correlation[] — Correlations calculated with various onset delay hyper-parameters
      - `correlationsOverDurationsOfActionChartConfig` object — Highchart config illustrating correlations calculated with various duration of action hyper-parameters
      - `correlationsOverOnsetDelaysChartConfig` object — Highchart config illustrating correlations calculated with various onset delay hyper-parameters
      - `numberOfUsers` number — Ex: 1
      - `rawCauseMeasurementSignificance` number, double — Ex: 1
      - `rawEffectMeasurementSignificance` number, double — Ex: 1
      - `reversePairsCount` string — Ex: 1
      - `voteStatisticalSignificance` integer — Ex: 1
      - `aggregateQMScore` number, double — Ex: 0.011598441286655
      - `forwardPearsonCorrelationCoefficient` number, double — Ex: 0.0333
      - `numberOfCorrelations` integer — Ex: 6
      - `vote` number — Ex: 1 or 0
    - `explanation` Explanation, required
      - `description` string, required — Ex: These factors are most predictive of Overall Mood based on your own data.
      - `image` Image, required
        - `height` string, required — Ex: 240
        - `imageUrl` string, required — Ex: https://www.filepicker.io/api/file/TjmeNWS5Q2SFmtJlUGLf
        - `width` string, required — Ex: 224
      - `ionIcon` string, required — Ex: ion-ios-person
      - `startTracking` ExplanationStartTracking, required
        - `button` Button, required
          - `accessibilityText` string — Ex: connect
          - `action` object — Action data
          - `additionalInformation` string — Ex: connect
          - `color` string — Ex: #f2f2f2
          - `confirmationText` string — Text to show user before executing functionName
          - `functionName` string — Name of function to call
          - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
          - `html` string — Ex: connect
          - `id` string — HTML element id
          - `image` string — Ex: https://image.jpg
          - `ionIcon` string — Ex: ion-refresh
          - `link` string, required — Ex: https://local.quantimo.do
          - `stateName` string — State to go to
          - `stateParams` object — Data to provide to the state
          - `successToastText` string — Text to show user after executing functionName
          - `successAlertTitle` string — Text to show user after executing functionName
          - `successAlertBody` string — Text to show user after executing functionName
          - `text` string, required — Ex: Connect
          - `tooltip` string — Ex: This is a tooltip
          - `webhookUrl` string — Post here on button click
        - `description` string, required — Ex: The more data I have the more accurate your results will be so track regularly!
        - `title` string, required — Ex: Improve Accuracy
      - `title` string, required — Ex: Top Predictors of Overall Mood
      - `html` string — Embeddable list of study summaries with explanation at the top
    - `description` string — Can be used as body of help info popup
    - `summary` string — Can be used as title in help info popup
    - `errors` Error[] — Array of error objects with message property
      - `message` string, required — Error message
    - `status` string — ex. OK or ERROR
    - `success` boolean — true or false
    - `code` number — Response code such as 200
    - `link` string — A super neat url you might want to share with your users!
    - `card` Card
      - `actionSheetButtons` Button[]
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `avatar` string — Smaller square image
      - `avatarCircular` string — Smaller circular image
      - `backgroundColor` string — Ex: #f2f2f2
      - `buttons` Button[]
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `buttonsSecondary` Button[]
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `content` string — Ex: Content
      - `headerTitle` string — Ex: Title
      - `html` string — HTML for the entire card.
      - `htmlContent` string — Ex: <div>Content</div>
      - `id` string, required — HTML element id
      - `image` string — Larger image of variable dimensions
      - `inputFields` InputField[]
        - `displayName` string, required
        - `helpText` string
        - `hint` string
        - `icon` string
        - `id` string — HTML element id
        - `image` string
        - `key` string
        - `labelLeft` string
        - `labelRight` string
        - `link` string
        - `maxLength` integer
        - `maxValue` number
        - `minLength` integer
        - `minValue` number
        - `options` string[] — Selector list options
        - `placeholder` string — Ex: Title
        - `postUrl` string
        - `required` boolean
        - `show` boolean — Ex: Title
        - `submitButton` Button
          - `accessibilityText` string — Ex: connect
          - `action` object — Action data
          - `additionalInformation` string — Ex: connect
          - `color` string — Ex: #f2f2f2
          - `confirmationText` string — Text to show user before executing functionName
          - `functionName` string — Name of function to call
          - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
          - `html` string — Ex: connect
          - `id` string — HTML element id
          - `image` string — Ex: https://image.jpg
          - `ionIcon` string — Ex: ion-refresh
          - `link` string, required — Ex: https://local.quantimo.do
          - `stateName` string — State to go to
          - `stateParams` object — Data to provide to the state
          - `successToastText` string — Text to show user after executing functionName
          - `successAlertTitle` string — Text to show user after executing functionName
          - `successAlertBody` string — Text to show user after executing functionName
          - `text` string, required — Ex: Connect
          - `tooltip` string — Ex: This is a tooltip
          - `webhookUrl` string — Post here on button click
        - `type` 'check_box' | 'date' | 'email' | 'number' | 'postal_code' | 'select_option' | 'string' | 'switch' | 'text_area' | 'unit' | 'variable_category', required — Ex: Title
        - `validationPattern` string — See http://html5pattern.com/ for examples
        - `value` string
      - `ionIcon` string — Ex: ion-refresh
      - `link` string — A link to a web page or something. Not much more to say about that.
      - `parameters` object — Key value pairs derived from user input fields, button clicks, or preset defaults
      - `relatedCards` Card[]
      - `selectedButton` Button
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `sharingBody` string — Ex: sharingBody
      - `sharingButtons` Button[]
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `sharingTitle` string — Ex: sharingTitle
      - `subHeader` string — Ex: subTitle
      - `subTitle` string — Ex: subTitle
      - `title` string — Ex: Title
  - `description` string, required — Can be used as body of help info popup
  - `summary` string, required — Can be used as title in help info popup
  - `avatar` string — Square icon png url
  - `errors` Error[] — Array of error objects with message property
    - `message` string, required — Error message
  - `status` string — ex. OK or ERROR
  - `success` boolean — true or false
  - `code` number — Response code such as 200
  - `link` string — A super neat url you might want to share with your users!
  - `card` Card
    - `actionSheetButtons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `avatar` string — Smaller square image
    - `avatarCircular` string — Smaller circular image
    - `backgroundColor` string — Ex: #f2f2f2
    - `buttons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `buttonsSecondary` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `content` string — Ex: Content
    - `headerTitle` string — Ex: Title
    - `html` string — HTML for the entire card.
    - `htmlContent` string — Ex: <div>Content</div>
    - `id` string, required — HTML element id
    - `image` string — Larger image of variable dimensions
    - `inputFields` InputField[]
      - `displayName` string, required
      - `helpText` string
      - `hint` string
      - `icon` string
      - `id` string — HTML element id
      - `image` string
      - `key` string
      - `labelLeft` string
      - `labelRight` string
      - `link` string
      - `maxLength` integer
      - `maxValue` number
      - `minLength` integer
      - `minValue` number
      - `options` string[] — Selector list options
      - `placeholder` string — Ex: Title
      - `postUrl` string
      - `required` boolean
      - `show` boolean — Ex: Title
      - `submitButton` Button
        - `accessibilityText` string — Ex: connect
        - `action` object — Action data
        - `additionalInformation` string — Ex: connect
        - `color` string — Ex: #f2f2f2
        - `confirmationText` string — Text to show user before executing functionName
        - `functionName` string — Name of function to call
        - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
        - `html` string — Ex: connect
        - `id` string — HTML element id
        - `image` string — Ex: https://image.jpg
        - `ionIcon` string — Ex: ion-refresh
        - `link` string, required — Ex: https://local.quantimo.do
        - `stateName` string — State to go to
        - `stateParams` object — Data to provide to the state
        - `successToastText` string — Text to show user after executing functionName
        - `successAlertTitle` string — Text to show user after executing functionName
        - `successAlertBody` string — Text to show user after executing functionName
        - `text` string, required — Ex: Connect
        - `tooltip` string — Ex: This is a tooltip
        - `webhookUrl` string — Post here on button click
      - `type` 'check_box' | 'date' | 'email' | 'number' | 'postal_code' | 'select_option' | 'string' | 'switch' | 'text_area' | 'unit' | 'variable_category', required — Ex: Title
      - `validationPattern` string — See http://html5pattern.com/ for examples
      - `value` string
    - `ionIcon` string — Ex: ion-refresh
    - `link` string — A link to a web page or something. Not much more to say about that.
    - `parameters` object — Key value pairs derived from user input fields, button clicks, or preset defaults
    - `relatedCards` Card[]
    - `selectedButton` Button
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `sharingBody` string — Ex: sharingBody
    - `sharingButtons` Button[]
      - `accessibilityText` string — Ex: connect
      - `action` object — Action data
      - `additionalInformation` string — Ex: connect
      - `color` string — Ex: #f2f2f2
      - `confirmationText` string — Text to show user before executing functionName
      - `functionName` string — Name of function to call
      - `parameters` object — Data to provide to functionName or be copied to the card parameters when button is clicked and card is posted to the API
      - `html` string — Ex: connect
      - `id` string — HTML element id
      - `image` string — Ex: https://image.jpg
      - `ionIcon` string — Ex: ion-refresh
      - `link` string, required — Ex: https://local.quantimo.do
      - `stateName` string — State to go to
      - `stateParams` object — Data to provide to the state
      - `successToastText` string — Text to show user after executing functionName
      - `successAlertTitle` string — Text to show user after executing functionName
      - `successAlertBody` string — Text to show user after executing functionName
      - `text` string, required — Ex: Connect
      - `tooltip` string — Ex: This is a tooltip
      - `webhookUrl` string — Post here on button click
    - `sharingTitle` string — Ex: sharingTitle
    - `subHeader` string — Ex: subTitle
    - `subTitle` string — Ex: subTitle
    - `title` string — Ex: Title

## Other responses

- `401` — Not Authenticated

---

[API](https://skmtc.net/quantimo/apis/curedao-unified-health-api.md) · [All operations](https://skmtc.net/quantimo/apis/curedao-unified-health-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quantimo/curedao-unified-health-api/versions/7ac03025c3d2/schema)