--- title: "Get Personal or Population Studies" method: GET path: "/v3/studies" tags: ["studies"] --- # Get Personal or Population Studies `GET /v3/studies` If you have enough data, this will be a list of your personal studies, otherwise it will consist of aggregated population studies. ## Query parameters - `causeVariableName` string - `effectVariableName` string - `causeVariableId` integer - `effectVariableId` integer - `predictorVariableName` string - `outcomeVariableName` string - `userId` number - `clientId` string - `includeCharts` boolean - `recalculate` boolean - `studyId` string - `sort` string - `limit` integer - `offset` integer - `correlationCoefficient` string - `updatedAt` string - `outcomesOfInterest` boolean - `principalInvestigatorUserId` integer - `open` boolean - `joined` boolean - `created` boolean - `population` boolean - `downvoted` boolean ## Response `200` Successful operation - GetStudiesResponse - `studies` Study[] - `type` string, required — Ex: population, cohort, or individual - `userId` integer — The user id of the principal investigator or subject if an individual studies - `id` string — ID of the cohort study which is necessary to allow participants to join - `causeVariable` Variable - `actionArray` TrackingReminderNotificationAction[] - `action` string, required — Ex: track - `callback` string, required — Ex: trackThreeRatingAction - `modifiedValue` integer, required — Ex: 3 - `title` string, required — Ex: 3/5 - `longTitle` string — Ex: Rate 3/5 - `shortTitle` string — Ex: 3 - `alias` string — User-Defined Variable Setting: Alternative display name - `availableUnits` Unit[] - `abbreviatedName` string, required — Unit abbreviation - `advanced` integer — Ex: 1 - `category` 'Distance' | 'Duration' | 'Energy' | 'Frequency' | 'Miscellany' | 'Pressure' | 'Proportion' | 'Rating' | 'Temperature' | 'Volume' | 'Weight' | 'Count', required — Unit category - `categoryId` integer — Ex: 6 - `categoryName` string — Ex: Miscellany - `conversionSteps` ConversionStep[], required — Conversion steps list - `operation` 'ADD' | 'MULTIPLY', required — ADD or MULTIPLY - `value` number, double, required — This specifies the order of conversion steps starting with 0 - `id` integer — Ex: 29 - `manualTracking` integer — Ex: 0 - `maximumAllowedValue` number, double — The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. - `maximumValue` integer, required — Ex: 4 - `minimumAllowedValue` number, double — The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. - `minimumValue` integer — Ex: 0 - `name` string, required — Unit name - `unitCategory` UnitCategory, required - `id` integer — id - `name` string, required — Category name - `standardUnitAbbreviatedName` string — Base unit for in which measurements are to be converted to and stored - `bestStudyLink` string — Link to study comparing variable with strongest relationship for user or population - `bestStudyCard` 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:
Content
- `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 - `bestUserStudyLink` string — Link to study comparing variable with strongest relationship for user - `bestUserStudyCard` 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:
Content
- `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 - `bestPopulationStudyLink` string — Link to study comparing variable with strongest relationship for population - `bestPopulationStudyCard` 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:
Content
- `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 - `optimalValueMessage` string — Description of relationship with variable with strongest relationship for user or population - `commonOptimalValueMessage` string — Description of relationship with variable with strongest relationship for population - `userOptimalValueMessage` string — Description of relationship with variable with strongest relationship for user - `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:
Content
- `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 - `causeOnly` boolean — 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` VariableCharts — An object with various chart properties each property contain and svg and Highcharts configuration - `hourlyColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `monthlyColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `distributionColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `weekdayColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `lineChartWithoutSmoothing` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `lineChartWithSmoothing` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `chartsLinkDynamic` string — 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` string — 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` string — 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` string — 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` string — 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` string — 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` Variable[] — 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. - `childUserTagVariables` Variable[] — 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. - `clientId` string — Your CureDAO client id can be obtained by creating an app at https://builder.quantimo.do - `combinationOperation` 'MEAN' | 'SUM' — 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. - `commonAlias` string — Ex: Anxiety / Nervousness - `commonTaggedVariables` Variable[] - `commonTagVariables` Variable[] - `createdAt` string — When the record was first created. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format - `dataSourceNames` string — Comma-separated list of source names to limit variables to those sources - `dataSources` DataSource[] — These are sources of measurements for this variable - `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:
Content
- `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: CureDAO - `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: CureDAO - `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 - `description` string — User-Defined Variable Setting: Ex: Summary to be used in studies. - `displayName` string — Ex: Trader Joe's Bedtime Tea - `durationOfAction` integer — 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 - `earliestFillingTime` integer — Earliest filling time - `earliestMeasurementTime` integer — Earliest measurement time - `earliestSourceTime` integer — Earliest source time - `errorMessage` string — Error message from last analysis - `experimentEndTime` string — User-Defined Variable Setting: Latest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss. - `experimentStartTime` string — User-Defined Variable Setting: Earliest measurement time to be used in analysis. Format: UTC ISO 8601 YYYY-MM-DDThh:mm:ss. - `fillingType` 'none' | 'zero-filling' | 'value-filling' — 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. - `fillingValue` number, float — 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. - `iconIcon` string — Ex: ion-sad-outline - `id` integer, required — Ex: 95614 - `imageUrl` string - `informationalUrl` string — Ex: https://google.com - `ingredientOfCommonTagVariables` Variable[] — 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. - `ingredientCommonTagVariables` Variable[] — 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. - `ingredientOfUserTagVariables` Variable[] — 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. - `ingredientUserTagVariables` Variable[] — 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. - `inputType` string — Type of input field to show for recording measurements - `ionIcon` string - `joinedCommonTagVariables` Variable[] — 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. - `joinedUserTagVariables` Variable[] — 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. - `joinWith` integer — Duplicate variables. If the variable is joined with some other variable then it is not shown to user in the list of variables - `kurtosis` number, float — Kurtosis - `lastProcessedDailyValue` number, double — Calculated Statistic: Ex: 500. Unit: User-specified or common. - `lastSuccessfulUpdateTime` string — When this variable or its settings were last updated UTC ISO 8601 YYYY-MM-DDThh:mm:ss - `lastValue` number, float — Calculated Statistic: Last measurement value in the common unit or user unit if different. Unit: User-specified or common. - `latestFillingTime` integer — Latest filling time - `latestMeasurementTime` integer — Latest measurement time. Format: Unix-time epoch seconds. - `latestSourceTime` integer — Latest source time. Format: Unix-time epoch seconds. - `latestUserMeasurementTime` integer — Ex: 1501383600. Format: Unix-time epoch seconds. - `latitude` number, float — Latitude. Unit: User-specified or common. - `location` string — Location - `longitude` number, float — Longitude - `manualTracking` boolean — True if the variable is an emotion or symptom rating that is not typically automatically collected by a device or app. - `maximumAllowedDailyValue` number, float — User-Defined Variable Setting: The maximum allowed value a daily aggregated measurement. Unit: User-specified or common. - `maximumAllowedValue` number, float — 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. - `maximumRecordedDailyValue` number, float — Calculated Statistic: Maximum recorded daily value of this variable. Unit: User-specified or common. - `maximumRecordedValue` number, double — Calculated Statistic: Ex: 1. Unit: User-specified or common. - `mean` number, float — Mean. Unit: User-specified or common. - `measurementsAtLastAnalysis` integer — Number of measurements at last analysis - `median` number, float — Median - `minimumAllowedValue` number, float — 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 - `minimumAllowedDailyValue` number, float — 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. - `minimumNonZeroValue` number, float — 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. - `minimumRecordedValue` number, float — Minimum recorded value of this variable. Unit: User-specified or common. - `mostCommonConnectorId` integer — Ex: 51 - `mostCommonOriginalUnitId` integer — Ex: 23 - `mostCommonUnitId` integer — Most common Unit ID - `mostCommonValue` number, float — Calculated Statistic: Most common value. Unit: User-specified or common. - `name` string, required — Ex: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand) - `numberOfAggregateCorrelationsAsCause` integer — Ex: 1 - `numberOfAggregateCorrelationsAsEffect` integer — Ex: 310 - `numberOfChanges` integer — Number of changes - `numberOfCorrelations` integer — Number of correlations for this variable - `numberOfCorrelationsAsCause` integer — numberOfAggregateCorrelationsAsCause plus numberOfUserCorrelationsAsCause - `numberOfCorrelationsAsEffect` integer — numberOfAggregateCorrelationsAsEffect plus numberOfUserCorrelationsAsEffect - `numberOfProcessedDailyMeasurements` integer — Number of processed measurements - `numberOfRawMeasurements` integer — Ex: 295 - `numberOfTrackingReminders` integer — Ex: 1 - `numberOfUniqueDailyValues` number, float — Number of unique daily values - `numberOfUniqueValues` integer — Ex: 2 - `numberOfUserCorrelationsAsCause` integer — Ex: 115 - `numberOfUserCorrelationsAsEffect` integer — Ex: 29014 - `numberOfUserVariables` integer — Ex: 2 - `onsetDelay` integer — 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. - `onsetDelayInHours` number, double — 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. - `outcome` boolean — 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` boolean — Do you want to receive updates on newly discovered factors influencing this variable? - `parentCommonTagVariables` Variable[] — 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. - `parentUserTagVariables` Variable[] — 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. - `pngPath` string — Ex: img/variable_categories/treatments.png - `pngUrl` string — Ex: https://web.quantimo.do/img/variable_categories/treatments.png - `predictorOfInterest` integer — Ex: 0 - `price` number, double — Ex: 95.4 - `productUrl` string — Link to associated product for purchase - `public` boolean — Should this variable show up in automcomplete searches for users who do not already have measurements for it? - `question` string — Ex: How is your overall mood? - `longQuestion` string — Ex: How is your overall mood on a scale of 1 to 5?? - `rawMeasurementsAtLastAnalysis` integer — Ex: 131 - `secondMostCommonValue` number, double — Calculated Statistic: Ex: 1. Unit: User-specified or common. - `secondToLastValue` number, double — Calculated Statistic: Ex: 250. Unit: User-specified or common. - `shareUserMeasurements` boolean — Would you like to make your measurements publicly visible? - `skewness` number, float — Skewness - `standardDeviation` number, double — Standard deviation Ex: 0.46483219855434 - `status` string — status - `subtitle` string — Based on sort filter and can be shown beneath variable name on search list - `svgUrl` string — Ex: https://web.quantimo.do/img/variable_categories/treatments.svg - `thirdMostCommonValue` number, double — Calculated Statistic: Ex: 6. Unit: User-specified or common. - `thirdToLastValue` number, double — Calculated Statistic: Ex: 250. Unit: User-specified or common. - `trackingInstructions` string — HTML instructions for tracking - `trackingInstructionsCard` 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:
Content
- `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 - `unit` Unit - `abbreviatedName` string, required — Unit abbreviation - `advanced` integer — Ex: 1 - `category` 'Distance' | 'Duration' | 'Energy' | 'Frequency' | 'Miscellany' | 'Pressure' | 'Proportion' | 'Rating' | 'Temperature' | 'Volume' | 'Weight' | 'Count', required — Unit category - `categoryId` integer — Ex: 6 - `categoryName` string — Ex: Miscellany - `conversionSteps` ConversionStep[], required — Conversion steps list - `operation` 'ADD' | 'MULTIPLY', required — ADD or MULTIPLY - `value` number, double, required — This specifies the order of conversion steps starting with 0 - `id` integer — Ex: 29 - `manualTracking` integer — Ex: 0 - `maximumAllowedValue` number, double — The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. - `maximumValue` integer, required — Ex: 4 - `minimumAllowedValue` number, double — The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. - `minimumValue` integer — Ex: 0 - `name` string, required — Unit name - `unitCategory` UnitCategory, required - `id` integer — id - `name` string, required — Category name - `standardUnitAbbreviatedName` string — Base unit for in which measurements are to be converted to and stored - `unitAbbreviatedName` string — Ex: count - `unitCategoryId` integer — Ex: 6 - `unitCategoryName` string — Ex: Miscellany - `unitId` integer — ID of unit to use for this variable - `unitName` string — User-Defined Variable Setting: Count - `upc` string — Universal product code or similar - `updated` integer — updated - `updatedAt` string — When the record in the database was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format - `updatedTime` string — Ex: 2017-07-30 14:58:26 - `userId` integer, required — User ID - `userTaggedVariables` Variable[] - `userTagVariables` Variable[] - `userVariableUnitAbbreviatedName` string — Ex: count - `userVariableUnitCategoryId` integer — Ex: 6 - `userVariableUnitCategoryName` string — Ex: Miscellany - `userVariableUnitId` integer — Ex: 23 - `userVariableUnitName` string — Ex: Count - `variableCategory` VariableCategory - `appType` string — Ex: mood - `causeOnly` boolean — Ex: false - `combinationOperation` string — Ex: MEAN - `createdTime` string — UTC ISO 8601 YYYY-MM-DDThh:mm:ss - `unitAbbreviatedName` string — Ex: /5 - `unitId` integer — Ex: 10 - `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 - `fillingValue` integer — Ex: -1. Unit: Variable category default unit. - `helpText` string — Ex: What emotion do you want to rate? - `id` integer — Ex: 1 - `imageUrl` string — Ex: https://static.quantimo.do/img/variable_categories/theatre_mask-96.png - `ionIcon` string — Ex: ion-happy-outline - `manualTracking` boolean — Ex: true - `maximumAllowedValue` string — Unit: Variable category default unit. - `measurementSynonymSingularLowercase` string — Ex: rating - `minimumAllowedValue` string — Unit: Variable category default unit. - `moreInfo` string — 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` string, required — Category name - `onsetDelay` integer — Ex: 0 - `outcome` boolean — Ex: true - `pngPath` string — Ex: img/variable_categories/emotions.png - `pngUrl` string — Ex: https://web.quantimo.do/img/variable_categories/emotions.png - `public` boolean — Ex: true - `svgPath` string — Ex: img/variable_categories/emotions.svg - `svgUrl` string — Ex: https://web.quantimo.do/img/variable_categories/emotions.svg - `updated` integer — Ex: 1 - `updatedTime` string — UTC ISO 8601 YYYY-MM-DDThh:mm:ss - `variableCategoryName` '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' — Ex: Emotions, Treatments, Symptoms... - `variableCategoryNameSingular` string — Ex: Emotion - `joinedVariables` Variable[] — Array of Variables that are joined with this Variable - `valence` string — 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` integer — Ex: 6 - `variableCategoryName` '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' — User-Defined Variable Setting: Variable category like Emotions, Sleep, Physical Activities, Treatments, Symptoms, etc. - `variableId` integer, required — Ex: 96380 - `variableName` string — Ex: Sleep Duration - `variance` number, double — Statistic: Ex: 115947037.40816 - `wikipediaTitle` string — User-Defined Variable Setting: You can help to improve the studies by pasting the title of the most appropriate Wikipedia article for this variable - `causeVariableName` string — Ex: Sleep Quality - `studyCharts` StudyCharts — An object with various chart properties each property contain and svg and Highcharts configuration - `populationTraitScatterPlot` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `outcomeDistributionColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `predictorDistributionColumnChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `correlationScatterPlot` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `pairsOverTimeLineChart` Chart - `highchartConfig` object — Highcharts config that can be used if you have highcharts.js included on the page - `chartId` string — Ex: correlationScatterPlot - `chartTitle` string — Ex: Overall Mood following Sleep Duration (R = -0.173) - `explanation` string — Ex: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. - `svgUrl` string — Url to a static svg of the chart - `svg` string — SVG string than can be embedded directly in HTML - `effectVariable` Variable - `actionArray` TrackingReminderNotificationAction[] - `action` string, required — Ex: track - `callback` string, required — Ex: trackThreeRatingAction - `modifiedValue` integer, required — Ex: 3 - `title` string, required — Ex: 3/5 - `longTitle` string — Ex: Rate 3/5 - `shortTitle` string — Ex: 3 - `alias` string — User-Defined Variable Setting: Alternative display name - `availableUnits` Unit[] - `abbreviatedName` string, required — Unit abbreviation - `advanced` integer — Ex: 1 - `category` 'Distance' | 'Duration' | 'Energy' | 'Frequency' | 'Miscellany' | 'Pressure' | 'Proportion' | 'Rating' | 'Temperature' | 'Volume' | 'Weight' | 'Count', required — Unit category - `categoryId` integer — Ex: 6 - `categoryName` string — Ex: Miscellany - `conversionSteps` ConversionStep[], required — Conversion steps list - `operation` 'ADD' | 'MULTIPLY', required — ADD or MULTIPLY - `value` number, double, required — This specifies the order of conversion steps starting with 0 - `id` integer — Ex: 29 - `manualTracking` integer — Ex: 0 - `maximumAllowedValue` number, double — The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. - `maximumValue` integer, required — Ex: 4 - `minimumAllowedValue` number, double — The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. - `minimumValue` integer — Ex: 0 - `name` string, required — Unit name - `unitCategory` UnitCategory, required - `id` integer — id - `name` string, required — Category name - `standardUnitAbbreviatedName` string — Base unit for in which measurements are to be converted to and stored - `bestStudyLink` string — Link to study comparing variable with strongest relationship for user or population - `bestStudyCard` 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:
Content
- `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 - `bestUserStudyLink` string — Link to study comparing variable with strongest relationship for user - `bestUserStudyCard` 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:
Content
- `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 - `bestPopulationStudyLink` string — Link to study comparing variable with strongest relationship for population - `bestPopulationStudyCard` 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:
Content
- `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 - `optimalValueMessage` string — Description of relationship with variable with strongest relationship for user or population - `commonOptimalValueMessage` string — Description of relationship with variable with strongest relationship for population - `userOptimalValueMessage` string — Description of relationship with variable with strongest relationship for user - `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 - … truncated; see the full OpenAPI document linked below ## Other responses - `401` — Successful operation - `404` — Not found - `500` — Internal server error --- [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/revisions/7ac03025c3d2/schema)