GET
/
v3
/
correlations
Get user variable relationships
curl --request GET \
  --url https://safe.dfda.earth/api/v3/correlations \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "correlations": [
      {
        "averageDailyHighCause": 123,
        "averageDailyLowCause": 123,
        "averageEffect": 123,
        "averageEffectFollowingHighCause": 123,
        "averageEffectFollowingLowCause": 123,
        "averageForwardPearsonCorrelationOverOnsetDelays": 123,
        "averageReversePearsonCorrelationOverOnsetDelays": 123,
        "averageVote": 123,
        "causeChanges": 123,
        "causeDataSource": {
          "affiliate": true,
          "backgroundColor": "<string>",
          "buttons": [
            {}
          ],
          "card": {
            "actionSheetButtons": [
              "<any>"
            ],
            "avatar": "<string>",
            "avatarCircular": "<string>",
            "backgroundColor": "<string>",
            "buttons": [
              "<any>"
            ],
            "buttonsSecondary": [
              "<any>"
            ],
            "content": "<string>",
            "headerTitle": "<string>",
            "html": "<string>",
            "htmlContent": "<string>",
            "id": "<string>",
            "image": "<string>",
            "inputFields": [
              "<any>"
            ],
            "ionIcon": "<string>",
            "link": "<string>",
            "parameters": {},
            "selectedButton": {},
            "sharingBody": "<string>",
            "sharingButtons": [
              "<any>"
            ],
            "sharingTitle": "<string>",
            "subHeader": "<string>",
            "subTitle": "<string>",
            "title": "<string>"
          },
          "clientId": "<string>",
          "connected": true,
          "connectError": "<string>",
          "connectInstructions": {
            "parameters": [
              "<any>"
            ],
            "url": "<string>",
            "usePopup": true
          },
          "connectorId": 123,
          "connectStatus": "<string>",
          "count": 123,
          "createdAt": "<string>",
          "connectorClientId": "<string>",
          "defaultVariableCategoryName": "<string>",
          "displayName": "<string>",
          "enabled": 123,
          "getItUrl": "<string>",
          "id": 123,
          "image": "<string>",
          "imageHtml": "<string>",
          "lastSuccessfulUpdatedAt": "<string>",
          "lastUpdate": 123,
          "linkedDisplayNameHtml": "<string>",
          "longDescription": "<string>",
          "message": "<string>",
          "mobileConnectMethod": "<string>",
          "name": "<string>",
          "platforms": [
            "<string>"
          ],
          "premium": true,
          "scopes": [
            "<string>"
          ],
          "shortDescription": "<string>",
          "spreadsheetUploadLink": "<string>",
          "totalMeasurementsInLastUpdate": 123,
          "updatedAt": "<string>",
          "updateRequestedAt": "<string>",
          "updateStatus": "<string>",
          "userId": 123
        },
        "causeUserVariableShareUserMeasurements": 123,
        "causeVariableCategoryId": 123,
        "causeVariableCategoryName": "<string>",
        "causeVariableCombinationOperation": "<string>",
        "causeVariableUnitAbbreviatedName": "<string>",
        "causeVariableId": 123,
        "causeVariableMostCommonConnectorId": 123,
        "causeVariableName": "<string>",
        "confidenceInterval": 123,
        "confidenceLevel": "<string>",
        "correlationCoefficient": 123,
        "correlationIsContradictoryToOptimalValues": true,
        "createdAt": "<string>",
        "criticalTValue": 123,
        "direction": "<string>",
        "durationOfAction": 123,
        "durationOfActionInHours": 123,
        "degreesOfFreedom": 123,
        "effectNumberOfProcessedDailyMeasurements": 123,
        "error": "<string>",
        "effectChanges": 123,
        "effectDataSource": {
          "affiliate": true,
          "backgroundColor": "<string>",
          "buttons": [
            {}
          ],
          "card": {
            "actionSheetButtons": [
              "<any>"
            ],
            "avatar": "<string>",
            "avatarCircular": "<string>",
            "backgroundColor": "<string>",
            "buttons": [
              "<any>"
            ],
            "buttonsSecondary": [
              "<any>"
            ],
            "content": "<string>",
            "headerTitle": "<string>",
            "html": "<string>",
            "htmlContent": "<string>",
            "id": "<string>",
            "image": "<string>",
            "inputFields": [
              "<any>"
            ],
            "ionIcon": "<string>",
            "link": "<string>",
            "parameters": {},
            "selectedButton": {},
            "sharingBody": "<string>",
            "sharingButtons": [
              "<any>"
            ],
            "sharingTitle": "<string>",
            "subHeader": "<string>",
            "subTitle": "<string>",
            "title": "<string>"
          },
          "clientId": "<string>",
          "connected": true,
          "connectError": "<string>",
          "connectInstructions": {
            "parameters": [
              "<any>"
            ],
            "url": "<string>",
            "usePopup": true
          },
          "connectorId": 123,
          "connectStatus": "<string>",
          "count": 123,
          "createdAt": "<string>",
          "connectorClientId": "<string>",
          "defaultVariableCategoryName": "<string>",
          "displayName": "<string>",
          "enabled": 123,
          "getItUrl": "<string>",
          "id": 123,
          "image": "<string>",
          "imageHtml": "<string>",
          "lastSuccessfulUpdatedAt": "<string>",
          "lastUpdate": 123,
          "linkedDisplayNameHtml": "<string>",
          "longDescription": "<string>",
          "message": "<string>",
          "mobileConnectMethod": "<string>",
          "name": "<string>",
          "platforms": [
            "<string>"
          ],
          "premium": true,
          "scopes": [
            "<string>"
          ],
          "shortDescription": "<string>",
          "spreadsheetUploadLink": "<string>",
          "totalMeasurementsInLastUpdate": 123,
          "updatedAt": "<string>",
          "updateRequestedAt": "<string>",
          "updateStatus": "<string>",
          "userId": 123
        },
        "effectSize": "<string>",
        "effectUnit": "<string>",
        "effectUserVariableShareUserMeasurements": 123,
        "effectVariableCategoryId": 123,
        "effectVariableCategoryName": "<string>",
        "effectVariableCombinationOperation": "<string>",
        "effectVariableCommonAlias": "<string>",
        "effectVariableUnitAbbreviatedName": "<string>",
        "effectVariableUnitId": 123,
        "effectVariableUnitName": "<string>",
        "effectVariableId": 123,
        "effectVariableMostCommonConnectorId": 123,
        "effectVariableName": "<string>",
        "experimentEndTime": "<string>",
        "experimentStartTime": "<string>",
        "forwardSpearmanCorrelationCoefficient": 123,
        "numberOfPairs": 123,
        "onsetDelay": 123,
        "onsetDelayInHours": 123,
        "onsetDelayWithStrongestPearsonCorrelation": 123,
        "onsetDelayWithStrongestPearsonCorrelationInHours": 123,
        "optimalPearsonProduct": 123,
        "outcomeFillingValue": 123,
        "outcomeMaximumAllowedValue": 123,
        "outcomeMinimumAllowedValue": 123,
        "pearsonCorrelationWithNoOnsetDelay": 123,
        "predictivePearsonCorrelation": 123,
        "predictivePearsonCorrelationCoefficient": 123,
        "predictorDataSources": "<string>",
        "predictorFillingValue": 123,
        "predictorMaximumAllowedValue": 123,
        "predictorMinimumAllowedValue": 123,
        "predictsHighEffectChange": 123,
        "predictsLowEffectChange": 123,
        "pValue": 123,
        "qmScore": 123,
        "reversePearsonCorrelationCoefficient": 123,
        "shareUserMeasurements": true,
        "sharingDescription": "<string>",
        "sharingTitle": "<string>",
        "significantDifference": true,
        "statisticalSignificance": 123,
        "strengthLevel": "<string>",
        "strongestPearsonCorrelationCoefficient": 123,
        "studyHtml": {
          "chartHtml": "<string>",
          "downloadButtonsHtml": "<string>",
          "fullPageWithHead": "<string>",
          "fullStudyHtml": "<string>",
          "fullStudyHtmlWithCssStyles": "<string>",
          "participantInstructionsHtml": "<string>",
          "statisticsTableHtml": "<string>",
          "studyAbstractHtml": "<string>",
          "studyHeaderHtml": "<string>",
          "studyImageHtml": "<string>",
          "studyMetaHtml": "<string>",
          "studyTextHtml": "<string>",
          "socialSharingButtonHtml": "<string>",
          "studySummaryBoxHtml": "<string>"
        },
        "studyImages": {
          "causeVariableImageUrl": "<string>",
          "causeVariableIonIcon": "<string>",
          "effectVariableImageUrl": "<string>",
          "effectVariableIonIcon": "<string>",
          "gaugeImage": "<string>",
          "gaugeImageSquare": "<string>",
          "gaugeSharingImageUrl": "<string>",
          "imageUrl": "<string>",
          "robotSharingImageUrl": "<string>",
          "avatar": "<string>"
        },
        "studyLinks": {
          "studyJoinLink": "<string>",
          "studyLinkEmail": "<string>",
          "studyLinkFacebook": "<string>",
          "studyLinkGoogle": "<string>",
          "studyLinkStatic": "<string>",
          "studyLinkDynamic": "<string>",
          "studyLinkTwitter": "<string>"
        },
        "studyText": {
          "averageEffectFollowingHighCauseExplanation": "<string>",
          "averageEffectFollowingLowCauseExplanation": "<string>",
          "valuePredictingHighOutcomeExplanation": "<string>",
          "valuePredictingLowOutcomeExplanation": "<string>",
          "dataAnalysis": "<string>",
          "dataSources": "<string>",
          "dataSourcesParagraphForCause": "<string>",
          "dataSourcesParagraphForEffect": "<string>",
          "lastCauseDailyValueSentenceExtended": "<string>",
          "lastCauseAndOptimalValueSentence": "<string>",
          "lastCauseDailyValueSentence": "<string>",
          "optimalDailyValueSentence": "<string>",
          "participantInstructions": "<string>",
          "predictorExplanation": "<string>",
          "significanceExplanation": "<string>",
          "studyAbstract": "<string>",
          "studyDesign": "<string>",
          "studyLimitations": "<string>",
          "studyObjective": "<string>",
          "studyResults": "<string>",
          "studyTitle": "<string>",
          "studyInvitation": "<string>",
          "studyQuestion": "<string>",
          "studyBackground": "<string>"
        },
        "tValue": 123,
        "updatedAt": "<string>",
        "userId": 123,
        "userVote": 123,
        "valuePredictingHighOutcome": 123,
        "valuePredictingLowOutcome": 123,
        "outcomeDataSources": "<string>",
        "principalInvestigator": "<string>",
        "reverseCorrelation": 123,
        "averagePearsonCorrelationCoefficientOverOnsetDelays": 123,
        "causeNumberOfRawMeasurements": 123,
        "correlationsOverDurationsOfAction": [
          {
            "averageDailyHighCause": 123,
            "averageDailyLowCause": 123,
            "averageEffect": 123,
            "averageEffectFollowingHighCause": 123,
            "averageEffectFollowingLowCause": 123,
            "averageForwardPearsonCorrelationOverOnsetDelays": 123,
            "averageReversePearsonCorrelationOverOnsetDelays": 123,
            "averageVote": 123,
            "causeChanges": 123,
            "causeDataSource": {
              "affiliate": true,
              "backgroundColor": "<string>",
              "buttons": [
                {}
              ],
              "card": {
                "actionSheetButtons": [
                  "<any>"
                ],
                "avatar": "<string>",
                "avatarCircular": "<string>",
                "backgroundColor": "<string>",
                "buttons": [
                  "<any>"
                ],
                "buttonsSecondary": [
                  "<any>"
                ],
                "content": "<string>",
                "headerTitle": "<string>",
                "html": "<string>",
                "htmlContent": "<string>",
                "id": "<string>",
                "image": "<string>",
                "inputFields": [
                  "<any>"
                ],
                "ionIcon": "<string>",
                "link": "<string>",
                "parameters": {},
                "selectedButton": {},
                "sharingBody": "<string>",
                "sharingButtons": [
                  "<any>"
                ],
                "sharingTitle": "<string>",
                "subHeader": "<string>",
                "subTitle": "<string>",
                "title": "<string>"
              },
              "clientId": "<string>",
              "connected": true,
              "connectError": "<string>",
              "connectInstructions": {
                "parameters": [
                  "<any>"
                ],
                "url": "<string>",
                "usePopup": true
              },
              "connectorId": 123,
              "connectStatus": "<string>",
              "count": 123,
              "createdAt": "<string>",
              "connectorClientId": "<string>",
              "defaultVariableCategoryName": "<string>",
              "displayName": "<string>",
              "enabled": 123,
              "getItUrl": "<string>",
              "id": 123,
              "image": "<string>",
              "imageHtml": "<string>",
              "lastSuccessfulUpdatedAt": "<string>",
              "lastUpdate": 123,
              "linkedDisplayNameHtml": "<string>",
              "longDescription": "<string>",
              "message": "<string>",
              "mobileConnectMethod": "<string>",
              "name": "<string>",
              "platforms": [
                "<string>"
              ],
              "premium": true,
              "scopes": [
                "<string>"
              ],
              "shortDescription": "<string>",
              "spreadsheetUploadLink": "<string>",
              "totalMeasurementsInLastUpdate": 123,
              "updatedAt": "<string>",
              "updateRequestedAt": "<string>",
              "updateStatus": "<string>",
              "userId": 123
            },
            "causeUserVariableShareUserMeasurements": 123,
            "causeVariableCategoryId": 123,
            "causeVariableCategoryName": "<string>",
            "causeVariableCombinationOperation": "<string>",
            "causeVariableUnitAbbreviatedName": "<string>",
            "causeVariableId": 123,
            "causeVariableMostCommonConnectorId": 123,
            "causeVariableName": "<string>",
            "confidenceInterval": 123,
            "confidenceLevel": "<string>",
            "correlationCoefficient": 123,
            "correlationIsContradictoryToOptimalValues": true,
            "createdAt": "<string>",
            "criticalTValue": 123,
            "direction": "<string>",
            "durationOfAction": 123,
            "durationOfActionInHours": 123,
            "degreesOfFreedom": 123,
            "effectNumberOfProcessedDailyMeasurements": 123,
            "error": "<string>",
            "effectChanges": 123,
            "effectDataSource": {
              "affiliate": true,
              "backgroundColor": "<string>",
              "buttons": [
                {}
              ],
              "card": {
                "actionSheetButtons": [
                  "<any>"
                ],
                "avatar": "<string>",
                "avatarCircular": "<string>",
                "backgroundColor": "<string>",
                "buttons": [
                  "<any>"
                ],
                "buttonsSecondary": [
                  "<any>"
                ],
                "content": "<string>",
                "headerTitle": "<string>",
                "html": "<string>",
                "htmlContent": "<string>",
                "id": "<string>",
                "image": "<string>",
                "inputFields": [
                  "<any>"
                ],
                "ionIcon": "<string>",
                "link": "<string>",
                "parameters": {},
                "selectedButton": {},
                "sharingBody": "<string>",
                "sharingButtons": [
                  "<any>"
                ],
                "sharingTitle": "<string>",
                "subHeader": "<string>",
                "subTitle": "<string>",
                "title": "<string>"
              },
              "clientId": "<string>",
              "connected": true,
              "connectError": "<string>",
              "connectInstructions": {
                "parameters": [
                  "<any>"
                ],
                "url": "<string>",
                "usePopup": true
              },
              "connectorId": 123,
              "connectStatus": "<string>",
              "count": 123,
              "createdAt": "<string>",
              "connectorClientId": "<string>",
              "defaultVariableCategoryName": "<string>",
              "displayName": "<string>",
              "enabled": 123,
              "getItUrl": "<string>",
              "id": 123,
              "image": "<string>",
              "imageHtml": "<string>",
              "lastSuccessfulUpdatedAt": "<string>",
              "lastUpdate": 123,
              "linkedDisplayNameHtml": "<string>",
              "longDescription": "<string>",
              "message": "<string>",
              "mobileConnectMethod": "<string>",
              "name": "<string>",
              "platforms": [
                "<string>"
              ],
              "premium": true,
              "scopes": [
                "<string>"
              ],
              "shortDescription": "<string>",
              "spreadsheetUploadLink": "<string>",
              "totalMeasurementsInLastUpdate": 123,
              "updatedAt": "<string>",
              "updateRequestedAt": "<string>",
              "updateStatus": "<string>",
              "userId": 123
            },
            "effectSize": "<string>",
            "effectUnit": "<string>",
            "effectUserVariableShareUserMeasurements": 123,
            "effectVariableCategoryId": 123,
            "effectVariableCategoryName": "<string>",
            "effectVariableCombinationOperation": "<string>",
            "effectVariableCommonAlias": "<string>",
            "effectVariableUnitAbbreviatedName": "<string>",
            "effectVariableUnitId": 123,
            "effectVariableUnitName": "<string>",
            "effectVariableId": 123,
            "effectVariableMostCommonConnectorId": 123,
            "effectVariableName": "<string>",
            "experimentEndTime": "<string>",
            "experimentStartTime": "<string>",
            "forwardSpearmanCorrelationCoefficient": 123,
            "numberOfPairs": 123,
            "onsetDelay": 123,
            "onsetDelayInHours": 123,
            "onsetDelayWithStrongestPearsonCorrelation": 123,
            "onsetDelayWithStrongestPearsonCorrelationInHours": 123,
            "optimalPearsonProduct": 123,
            "outcomeFillingValue": 123,
            "outcomeMaximumAllowedValue": 123,
            "outcomeMinimumAllowedValue": 123,
            "pearsonCorrelationWithNoOnsetDelay": 123,
            "predictivePearsonCorrelation": 123,
            "predictivePearsonCorrelationCoefficient": 123,
            "predictorDataSources": "<string>",
            "predictorFillingValue": 123,
            "predictorMaximumAllowedValue": 123,
            "predictorMinimumAllowedValue": 123,
            "predictsHighEffectChange": 123,
            "predictsLowEffectChange": 123,
            "pValue": 123,
            "qmScore": 123,
            "reversePearsonCorrelationCoefficient": 123,
            "shareUserMeasurements": true,
            "sharingDescription": "<string>",
            "sharingTitle": "<string>",
            "significantDifference": true,
            "statisticalSignificance": 123,
            "strengthLevel": "<string>",
            "strongestPearsonCorrelationCoefficient": 123,
            "studyHtml": {
              "chartHtml": "<string>",
              "downloadButtonsHtml": "<string>",
              "fullPageWithHead": "<string>",
              "fullStudyHtml": "<string>",
              "fullStudyHtmlWithCssStyles": "<string>",
              "participantInstructionsHtml": "<string>",
              "statisticsTableHtml": "<string>",
              "studyAbstractHtml": "<string>",
              "studyHeaderHtml": "<string>",
              "studyImageHtml": "<string>",
              "studyMetaHtml": "<string>",
              "studyTextHtml": "<string>",
              "socialSharingButtonHtml": "<string>",
              "studySummaryBoxHtml": "<string>"
            },
            "studyImages": {
              "causeVariableImageUrl": "<string>",
              "causeVariableIonIcon": "<string>",
              "effectVariableImageUrl": "<string>",
              "effectVariableIonIcon": "<string>",
              "gaugeImage": "<string>",
              "gaugeImageSquare": "<string>",
              "gaugeSharingImageUrl": "<string>",
              "imageUrl": "<string>",
              "robotSharingImageUrl": "<string>",
              "avatar": "<string>"
            },
            "studyLinks": {
              "studyJoinLink": "<string>",
              "studyLinkEmail": "<string>",
              "studyLinkFacebook": "<string>",
              "studyLinkGoogle": "<string>",
              "studyLinkStatic": "<string>",
              "studyLinkDynamic": "<string>",
              "studyLinkTwitter": "<string>"
            },
            "studyText": {
              "averageEffectFollowingHighCauseExplanation": "<string>",
              "averageEffectFollowingLowCauseExplanation": "<string>",
              "valuePredictingHighOutcomeExplanation": "<string>",
              "valuePredictingLowOutcomeExplanation": "<string>",
              "dataAnalysis": "<string>",
              "dataSources": "<string>",
              "dataSourcesParagraphForCause": "<string>",
              "dataSourcesParagraphForEffect": "<string>",
              "lastCauseDailyValueSentenceExtended": "<string>",
              "lastCauseAndOptimalValueSentence": "<string>",
              "lastCauseDailyValueSentence": "<string>",
              "optimalDailyValueSentence": "<string>",
              "participantInstructions": "<string>",
              "predictorExplanation": "<string>",
              "significanceExplanation": "<string>",
              "studyAbstract": "<string>",
              "studyDesign": "<string>",
              "studyLimitations": "<string>",
              "studyObjective": "<string>",
              "studyResults": "<string>",
              "studyTitle": "<string>",
              "studyInvitation": "<string>",
              "studyQuestion": "<string>",
              "studyBackground": "<string>"
            },
            "tValue": 123,
            "updatedAt": "<string>",
            "userId": 123,
            "userVote": 123,
            "valuePredictingHighOutcome": 123,
            "valuePredictingLowOutcome": 123,
            "outcomeDataSources": "<string>",
            "principalInvestigator": "<string>",
            "reverseCorrelation": 123,
            "averagePearsonCorrelationCoefficientOverOnsetDelays": 123,
            "causeNumberOfRawMeasurements": 123,
            "numberOfUsers": 123,
            "rawCauseMeasurementSignificance": 123,
            "rawEffectMeasurementSignificance": 123,
            "reversePairsCount": "<string>",
            "voteStatisticalSignificance": 123,
            "aggregateQMScore": 123,
            "forwardPearsonCorrelationCoefficient": 123,
            "numberOfCorrelations": 123,
            "vote": 123
          }
        ],
        "correlationsOverOnsetDelays": [
          {
            "averageDailyHighCause": 123,
            "averageDailyLowCause": 123,
            "averageEffect": 123,
            "averageEffectFollowingHighCause": 123,
            "averageEffectFollowingLowCause": 123,
            "averageForwardPearsonCorrelationOverOnsetDelays": 123,
            "averageReversePearsonCorrelationOverOnsetDelays": 123,
            "averageVote": 123,
            "causeChanges": 123,
            "causeDataSource": {
              "affiliate": true,
              "backgroundColor": "<string>",
              "buttons": [
                {}
              ],
              "card": {
                "actionSheetButtons": [
                  "<any>"
                ],
                "avatar": "<string>",
                "avatarCircular": "<string>",
                "backgroundColor": "<string>",
                "buttons": [
                  "<any>"
                ],
                "buttonsSecondary": [
                  "<any>"
                ],
                "content": "<string>",
                "headerTitle": "<string>",
                "html": "<string>",
                "htmlContent": "<string>",
                "id": "<string>",
                "image": "<string>",
                "inputFields": [
                  "<any>"
                ],
                "ionIcon": "<string>",
                "link": "<string>",
                "parameters": {},
                "selectedButton": {},
                "sharingBody": "<string>",
                "sharingButtons": [
                  "<any>"
                ],
                "sharingTitle": "<string>",
                "subHeader": "<string>",
                "subTitle": "<string>",
                "title": "<string>"
              },
              "clientId": "<string>",
              "connected": true,
              "connectError": "<string>",
              "connectInstructions": {
                "parameters": [
                  "<any>"
                ],
                "url": "<string>",
                "usePopup": true
              },
              "connectorId": 123,
              "connectStatus": "<string>",
              "count": 123,
              "createdAt": "<string>",
              "connectorClientId": "<string>",
              "defaultVariableCategoryName": "<string>",
              "displayName": "<string>",
              "enabled": 123,
              "getItUrl": "<string>",
              "id": 123,
              "image": "<string>",
              "imageHtml": "<string>",
              "lastSuccessfulUpdatedAt": "<string>",
              "lastUpdate": 123,
              "linkedDisplayNameHtml": "<string>",
              "longDescription": "<string>",
              "message": "<string>",
              "mobileConnectMethod": "<string>",
              "name": "<string>",
              "platforms": [
                "<string>"
              ],
              "premium": true,
              "scopes": [
                "<string>"
              ],
              "shortDescription": "<string>",
              "spreadsheetUploadLink": "<string>",
              "totalMeasurementsInLastUpdate": 123,
              "updatedAt": "<string>",
              "updateRequestedAt": "<string>",
              "updateStatus": "<string>",
              "userId": 123
            },
            "causeUserVariableShareUserMeasurements": 123,
            "causeVariableCategoryId": 123,
            "causeVariableCategoryName": "<string>",
            "causeVariableCombinationOperation": "<string>",
            "causeVariableUnitAbbreviatedName": "<string>",
            "causeVariableId": 123,
            "causeVariableMostCommonConnectorId": 123,
            "causeVariableName": "<string>",
            "confidenceInterval": 123,
            "confidenceLevel": "<string>",
            "correlationCoefficient": 123,
            "correlationIsContradictoryToOptimalValues": true,
            "createdAt": "<string>",
            "criticalTValue": 123,
            "direction": "<string>",
            "durationOfAction": 123,
            "durationOfActionInHours": 123,
            "degreesOfFreedom": 123,
            "effectNumberOfProcessedDailyMeasurements": 123,
            "error": "<string>",
            "effectChanges": 123,
            "effectDataSource": {
              "affiliate": true,
              "backgroundColor": "<string>",
              "buttons": [
                {}
              ],
              "card": {
                "actionSheetButtons": [
                  "<any>"
                ],
                "avatar": "<string>",
                "avatarCircular": "<string>",
                "backgroundColor": "<string>",
                "buttons": [
                  "<any>"
                ],
                "buttonsSecondary": [
                  "<any>"
                ],
                "content": "<string>",
                "headerTitle": "<string>",
                "html": "<string>",
                "htmlContent": "<string>",
                "id": "<string>",
                "image": "<string>",
                "inputFields": [
                  "<any>"
                ],
                "ionIcon": "<string>",
                "link": "<string>",
                "parameters": {},
                "selectedButton": {},
                "sharingBody": "<string>",
                "sharingButtons": [
                  "<any>"
                ],
                "sharingTitle": "<string>",
                "subHeader": "<string>",
                "subTitle": "<string>",
                "title": "<string>"
              },
              "clientId": "<string>",
              "connected": true,
              "connectError": "<string>",
              "connectInstructions": {
                "parameters": [
                  "<any>"
                ],
                "url": "<string>",
                "usePopup": true
              },
              "connectorId": 123,
              "connectStatus": "<string>",
              "count": 123,
              "createdAt": "<string>",
              "connectorClientId": "<string>",
              "defaultVariableCategoryName": "<string>",
              "displayName": "<string>",
              "enabled": 123,
              "getItUrl": "<string>",
              "id": 123,
              "image": "<string>",
              "imageHtml": "<string>",
              "lastSuccessfulUpdatedAt": "<string>",
              "lastUpdate": 123,
              "linkedDisplayNameHtml": "<string>",
              "longDescription": "<string>",
              "message": "<string>",
              "mobileConnectMethod": "<string>",
              "name": "<string>",
              "platforms": [
                "<string>"
              ],
              "premium": true,
              "scopes": [
                "<string>"
              ],
              "shortDescription": "<string>",
              "spreadsheetUploadLink": "<string>",
              "totalMeasurementsInLastUpdate": 123,
              "updatedAt": "<string>",
              "updateRequestedAt": "<string>",
              "updateStatus": "<string>",
              "userId": 123
            },
            "effectSize": "<string>",
            "effectUnit": "<string>",
            "effectUserVariableShareUserMeasurements": 123,
            "effectVariableCategoryId": 123,
            "effectVariableCategoryName": "<string>",
            "effectVariableCombinationOperation": "<string>",
            "effectVariableCommonAlias": "<string>",
            "effectVariableUnitAbbreviatedName": "<string>",
            "effectVariableUnitId": 123,
            "effectVariableUnitName": "<string>",
            "effectVariableId": 123,
            "effectVariableMostCommonConnectorId": 123,
            "effectVariableName": "<string>",
            "experimentEndTime": "<string>",
            "experimentStartTime": "<string>",
            "forwardSpearmanCorrelationCoefficient": 123,
            "numberOfPairs": 123,
            "onsetDelay": 123,
            "onsetDelayInHours": 123,
            "onsetDelayWithStrongestPearsonCorrelation": 123,
            "onsetDelayWithStrongestPearsonCorrelationInHours": 123,
            "optimalPearsonProduct": 123,
            "outcomeFillingValue": 123,
            "outcomeMaximumAllowedValue": 123,
            "outcomeMinimumAllowedValue": 123,
            "pearsonCorrelationWithNoOnsetDelay": 123,
            "predictivePearsonCorrelation": 123,
            "predictivePearsonCorrelationCoefficient": 123,
            "predictorDataSources": "<string>",
            "predictorFillingValue": 123,
            "predictorMaximumAllowedValue": 123,
            "predictorMinimumAllowedValue": 123,
            "predictsHighEffectChange": 123,
            "predictsLowEffectChange": 123,
            "pValue": 123,
            "qmScore": 123,
            "reversePearsonCorrelationCoefficient": 123,
            "shareUserMeasurements": true,
            "sharingDescription": "<string>",
            "sharingTitle": "<string>",
            "significantDifference": true,
            "statisticalSignificance": 123,
            "strengthLevel": "<string>",
            "strongestPearsonCorrelationCoefficient": 123,
            "studyHtml": {
              "chartHtml": "<string>",
              "downloadButtonsHtml": "<string>",
              "fullPageWithHead": "<string>",
              "fullStudyHtml": "<string>",
              "fullStudyHtmlWithCssStyles": "<string>",
              "participantInstructionsHtml": "<string>",
              "statisticsTableHtml": "<string>",
              "studyAbstractHtml": "<string>",
              "studyHeaderHtml": "<string>",
              "studyImageHtml": "<string>",
              "studyMetaHtml": "<string>",
              "studyTextHtml": "<string>",
              "socialSharingButtonHtml": "<string>",
              "studySummaryBoxHtml": "<string>"
            },
            "studyImages": {
              "causeVariableImageUrl": "<string>",
              "causeVariableIonIcon": "<string>",
              "effectVariableImageUrl": "<string>",
              "effectVariableIonIcon": "<string>",
              "gaugeImage": "<string>",
              "gaugeImageSquare": "<string>",
              "gaugeSharingImageUrl": "<string>",
              "imageUrl": "<string>",
              "robotSharingImageUrl": "<string>",
              "avatar": "<string>"
            },
            "studyLinks": {
              "studyJoinLink": "<string>",
              "studyLinkEmail": "<string>",
              "studyLinkFacebook": "<string>",
              "studyLinkGoogle": "<string>",
              "studyLinkStatic": "<string>",
              "studyLinkDynamic": "<string>",
              "studyLinkTwitter": "<string>"
            },
            "studyText": {
              "averageEffectFollowingHighCauseExplanation": "<string>",
              "averageEffectFollowingLowCauseExplanation": "<string>",
              "valuePredictingHighOutcomeExplanation": "<string>",
              "valuePredictingLowOutcomeExplanation": "<string>",
              "dataAnalysis": "<string>",
              "dataSources": "<string>",
              "dataSourcesParagraphForCause": "<string>",
              "dataSourcesParagraphForEffect": "<string>",
              "lastCauseDailyValueSentenceExtended": "<string>",
              "lastCauseAndOptimalValueSentence": "<string>",
              "lastCauseDailyValueSentence": "<string>",
              "optimalDailyValueSentence": "<string>",
              "participantInstructions": "<string>",
              "predictorExplanation": "<string>",
              "significanceExplanation": "<string>",
              "studyAbstract": "<string>",
              "studyDesign": "<string>",
              "studyLimitations": "<string>",
              "studyObjective": "<string>",
              "studyResults": "<string>",
              "studyTitle": "<string>",
              "studyInvitation": "<string>",
              "studyQuestion": "<string>",
              "studyBackground": "<string>"
            },
            "tValue": 123,
            "updatedAt": "<string>",
            "userId": 123,
            "userVote": 123,
            "valuePredictingHighOutcome": 123,
            "valuePredictingLowOutcome": 123,
            "outcomeDataSources": "<string>",
            "principalInvestigator": "<string>",
            "reverseCorrelation": 123,
            "averagePearsonCorrelationCoefficientOverOnsetDelays": 123,
            "causeNumberOfRawMeasurements": 123,
            "numberOfUsers": 123,
            "rawCauseMeasurementSignificance": 123,
            "rawEffectMeasurementSignificance": 123,
            "reversePairsCount": "<string>",
            "voteStatisticalSignificance": 123,
            "aggregateQMScore": 123,
            "forwardPearsonCorrelationCoefficient": 123,
            "numberOfCorrelations": 123,
            "vote": 123
          }
        ],
        "correlationsOverDurationsOfActionChartConfig": {},
        "correlationsOverOnsetDelaysChartConfig": {},
        "numberOfUsers": 123,
        "rawCauseMeasurementSignificance": 123,
        "rawEffectMeasurementSignificance": 123,
        "reversePairsCount": "<string>",
        "voteStatisticalSignificance": 123,
        "aggregateQMScore": 123,
        "forwardPearsonCorrelationCoefficient": 123,
        "numberOfCorrelations": 123,
        "vote": 123
      }
    ],
    "explanation": {
      "description": "<string>",
      "image": {
        "height": "<string>",
        "imageUrl": "<string>",
        "width": "<string>"
      },
      "ionIcon": "<string>",
      "startTracking": {
        "button": {
          "accessibilityText": "<any>",
          "action": "<any>",
          "additionalInformation": "<any>",
          "color": "<any>",
          "confirmationText": "<any>",
          "functionName": "<any>",
          "parameters": "<any>",
          "html": "<any>",
          "id": "<any>",
          "image": "<any>",
          "ionIcon": "<any>",
          "link": "<any>",
          "stateName": "<any>",
          "stateParams": "<any>",
          "successToastText": "<any>",
          "successAlertTitle": "<any>",
          "successAlertBody": "<any>",
          "text": "<any>",
          "tooltip": "<any>",
          "webhookUrl": "<any>"
        },
        "description": "<string>",
        "title": "<string>"
      },
      "title": "<string>",
      "html": "<string>"
    },
    "description": "<string>",
    "summary": "<string>",
    "errors": [
      {
        "message": "<string>"
      }
    ],
    "status": "<string>",
    "success": true,
    "code": 123,
    "link": "<string>",
    "card": {
      "actionSheetButtons": [
        "<any>"
      ],
      "avatar": "<string>",
      "avatarCircular": "<string>",
      "backgroundColor": "<string>",
      "buttons": [
        "<any>"
      ],
      "buttonsSecondary": [
        "<any>"
      ],
      "content": "<string>",
      "headerTitle": "<string>",
      "html": "<string>",
      "htmlContent": "<string>",
      "id": "<string>",
      "image": "<string>",
      "inputFields": [
        "<any>"
      ],
      "ionIcon": "<string>",
      "link": "<string>",
      "parameters": {},
      "selectedButton": {
        "accessibilityText": "<any>",
        "action": "<any>",
        "additionalInformation": "<any>",
        "color": "<any>",
        "confirmationText": "<any>",
        "functionName": "<any>",
        "parameters": "<any>",
        "html": "<any>",
        "id": "<any>",
        "image": "<any>",
        "ionIcon": "<any>",
        "link": "<any>",
        "stateName": "<any>",
        "stateParams": "<any>",
        "successToastText": "<any>",
        "successAlertTitle": "<any>",
        "successAlertBody": "<any>",
        "text": "<any>",
        "tooltip": "<any>",
        "webhookUrl": "<any>"
      },
      "sharingBody": "<string>",
      "sharingButtons": [
        "<any>"
      ],
      "sharingTitle": "<string>",
      "subHeader": "<string>",
      "subTitle": "<string>",
      "title": "<string>"
    }
  },
  "description": "<string>",
  "summary": "<string>",
  "avatar": "<string>",
  "errors": [
    {
      "message": "<string>"
    }
  ],
  "status": "<string>",
  "success": true,
  "code": 123,
  "link": "<string>",
  "card": {
    "actionSheetButtons": [
      "<any>"
    ],
    "avatar": "<string>",
    "avatarCircular": "<string>",
    "backgroundColor": "<string>",
    "buttons": [
      "<any>"
    ],
    "buttonsSecondary": [
      "<any>"
    ],
    "content": "<string>",
    "headerTitle": "<string>",
    "html": "<string>",
    "htmlContent": "<string>",
    "id": "<string>",
    "image": "<string>",
    "inputFields": [
      "<any>"
    ],
    "ionIcon": "<string>",
    "link": "<string>",
    "parameters": {},
    "selectedButton": {
      "accessibilityText": "<any>",
      "action": "<any>",
      "additionalInformation": "<any>",
      "color": "<any>",
      "confirmationText": "<any>",
      "functionName": "<any>",
      "parameters": "<any>",
      "html": "<any>",
      "id": "<any>",
      "image": "<any>",
      "ionIcon": "<any>",
      "link": "<any>",
      "stateName": "<any>",
      "stateParams": "<any>",
      "successToastText": "<any>",
      "successAlertTitle": "<any>",
      "successAlertBody": "<any>",
      "text": "<any>",
      "tooltip": "<any>",
      "webhookUrl": "<any>"
    },
    "sharingBody": "<string>",
    "sharingButtons": [
      "<any>"
    ],
    "sharingTitle": "<string>",
    "subHeader": "<string>",
    "subTitle": "<string>",
    "title": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format Bearer access_token_here

Query Parameters

​
causeVariableName
string

Deprecated: Name of the hypothetical predictor variable. Ex: Sleep Duration

​
effectVariableName
string

Deprecated: Name of the outcome variable of interest. Ex: Overall Mood

​
sort
string

Sort by one of the listed field names. If the field name is prefixed with -, it will sort in descending order.

​
limit
integer
default:100

The LIMIT is used to limit the number of results returned. So if youhave 1000 results, but only want to the first 10, you would set this to 10 and offset to 0. The maximum limit is 200 records.

​
offset
integer

OFFSET says to skip that many rows before beginning to return rows to the client. OFFSET 0 is the same as omitting the OFFSET clause.If both OFFSET and LIMIT appear, then OFFSET rows are skipped before starting to count the LIMIT rows that are returned.

Required range: x >= 0
​
correlationCoefficient
string

Pearson correlation coefficient between cause and effect after lagging by onset delay and grouping by duration of action

​
updatedAt
string

When the record was last updated. Use UTC ISO 8601 YYYY-MM-DDThh:mm:ss datetime format. Time zone should be UTC and not local.

​
outcomesOfInterest
boolean

Only include user_variable_relationships for which the effect is an outcome of interest for the user

​
clientId
string

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

​
commonOnly
boolean

Return only public, anonymized and aggregated population data instead of user-specific variables

Response

Successful operation

​
description
string
required

Can be used as body of help info popup

​
summary
string
required

Can be used as title in help info popup

​
data
object
​
avatar
string

Square icon png url

​
errors
object[]

Array of error objects with message property

​
status
string

ex. OK or ERROR

​
success
boolean

true or false

​
code
number

Response code such as 200

​
link
string

A super neat url you might want to share with your users!

​
card
object