basePath: /api consumes: - application/json definitions: AggregatedCorrelation: properties: aggregateQMScore: description: 'Example: 0.011598441286655' format: double type: number averageDailyHighCause: description: '' type: number averageDailyLowCause: description: '' type: number averageEffect: description: '' type: number averageEffectFollowingHighCause: description: '' type: number averageEffectFollowingHighCauseExplanation: description: '' type: string averageEffectFollowingLowCause: description: '' type: number averageEffectFollowingLowCauseExplanation: description: '' type: string averageForwardPearsonCorrelationOverOnsetDelays: description: 'Example: 0.396' format: double type: number averageReversePearsonCorrelationOverOnsetDelays: description: 'Example: 0.453667' format: double type: number averageVote: description: Average Vote type: number causalityFactor: description: '' type: number cause: description: >- Variable name of the cause variable for which the user desires correlations. type: string causeChanges: description: >- Number of changes in the predictor variable (a.k.a the number of experiments) type: integer causeDataSource: $ref: '#/definitions/DataSource' causeUnit: description: Unit of the predictor variable type: string causeUserVariableShareUserMeasurements: description: 'Example: 1' type: integer causeVariableCategoryId: description: 'Example: 6' type: integer causeVariableCategoryName: description: Variable category of the cause variable. type: string causeVariableCombinationOperation: description: The way cause measurements are aggregated type: string causeVariableCommonAlias: description: 'Example: ' type: string causeVariableUnitAbbreviatedName: description: 'Example: /5' type: string causeVariableUnitId: description: Unit Id of the predictor variable type: integer causeVariableUnitName: description: 'Example: 1 to 5 Rating' type: string causeVariableId: description: '' type: integer causeVariableImageUrl: description: '' type: string causeVariableInformationalUrl: description: 'Example: ' type: string causeVariableIonIcon: description: For use in Ionic apps type: string causeVariableMostCommonConnectorId: description: 'Example: 6' type: integer causeVariableName: description: >- Variable name of the cause variable for which the user desires correlations. type: string causeVariableProductUrl: description: 'Example: ' type: string confidenceInterval: description: 'Example: 0.14344467795996' format: double type: number confidenceLevel: description: 'Example: high' type: string correlationCoefficient: description: Pearson correlation coefficient between cause and effect measurements type: number correlationIsContradictoryToOptimalValues: description: 'Example: 1' type: boolean createdAt: description: >- When the record was first created. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string createdTime: description: 'Example: 2016-12-28 20:47:30' format: date-time type: string criticalTValue: description: 'Example: 1.646' format: double type: number dataAnalysis: description: How the data was analyzed type: string dataSources: description: How the data was obtained type: string dataSourcesParagraphForCause: description: >- Example: Sleep Quality data was primarily collected using Up by Jawbone. UP by Jawbone is a wristband and app that tracks how you sleep, move and eat and then helps you use that information to feel your best. type: string dataSourcesParagraphForEffect: description: >- Example: Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string direction: description: 'Example: higher' type: string durationOfAction: description: >- The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. type: number durationOfActionInHours: description: 'Example: 168' type: integer effect: description: >- Variable name of the effect variable for which the user desires correlations. type: string effectChanges: description: 'Example: 193' type: integer effectDataSource: $ref: '#/definitions/DataSource' effectSize: description: >- Magnitude of the effects of a cause indicating whether it's practically meaningful. type: string effectUnit: description: 'Example: /5' type: string effectUserVariableShareUserMeasurements: description: 'Example: 1' type: integer effectVariableCategoryId: description: 'Example: 1' type: integer effectVariableCategoryName: description: Variable category of the effect variable. type: string effectVariableCombinationOperation: description: 'Example: MEAN' type: string effectVariableCommonAlias: description: 'Example: Mood_(psychology)' type: string effectVariableUnitAbbreviatedName: description: 'Example: /5' type: string effectVariableUnitId: description: 'Example: 10' type: integer effectVariableUnitName: description: 'Example: 1 to 5 Rating' type: string effectVariableId: description: >- Magnitude of the effects of a cause indicating whether it's practically meaningful. type: string effectVariableImageUrl: description: '' type: string effectVariableInformationalUrl: description: 'Example: ' type: string effectVariableIonIcon: description: For use in Ionic apps type: string effectVariableMostCommonConnectorId: description: 'Example: 10' type: integer effectVariableName: description: >- Variable name of the effect variable for which the user desires correlations. type: string effectVariableProductUrl: description: 'Example: ' type: string experimentEndTime: description: 'Example: 2014-07-30 12:50:00' format: date-time type: string experimentStartTime: description: 'Example: 2012-05-06 21:15:00' format: date-time type: string forwardPearsonCorrelationCoefficient: description: 'Example: 0.0333' format: double type: number forwardSpearmanCorrelationCoefficient: description: 'Example: 0.528359' format: double type: number gaugeImage: description: Illustrates the strength of the relationship type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship-200-200.png type: string imageUrl: description: Large image for Facebook type: string instructionsForCause: description: >- Example: Obtain Up by Jawbone and use it to record your Sleep Quality. Once you have a Up by Jawbone account, connect your Up by Jawbone account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffect: description: >- Example: Obtain QuantiModo and use it to record your Overall Mood. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string numberOfCorrelations: description: 'Example: 6' type: integer numberOfPairs: description: Number of points that went into the correlation calculation type: number numberOfUsers: description: 'Example: 6' type: integer onsetDelay: description: >- The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes. format: double type: number onsetDelayInHours: description: 'Example: 0' type: integer onsetDelayWithStrongestPearsonCorrelation: description: 'Example: -86400' type: integer onsetDelayWithStrongestPearsonCorrelationInHours: description: 'Example: -24' type: integer optimalPearsonProduct: description: Optimal Pearson Product type: number outcomeDataSources: description: original name of the cause. type: string outcomeFillingValue: description: 'Example: -1' type: integer pearsonCorrelationWithNoOnsetDelay: description: 'Example: 0.477' format: double type: number perDaySentenceFragment: description: 'Example: ' type: string predictivePearsonCorrelation: description: 'Example: 0.538' format: double type: number predictivePearsonCorrelationCoefficient: description: 'Example: 0.538' format: double type: number predictorDataSources: description: 'Example: RescueTime' type: string predictorExplanation: description: HIGHER Remeron predicts HIGHER Overall Mood type: string predictorFillingValue: description: 'Example: -1' type: integer predictorMaximumAllowedValue: description: 'Example: 160934' format: double type: number predictorMinimumAllowedValue: description: 'Example: 10' format: double type: number predictsHighEffectChange: description: 'Example: 17' type: integer predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 17% ' type: string predictsLowEffectChange: description: 'Example: -11' type: integer predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 11% ' type: string principalInvestigator: description: Mike Sinn type: string pValue: description: 'Example: 3.5306635529222E-5' format: double type: number qmScore: description: >- Value representing the significance of the relationship as a function of crowdsourced insights, predictive strength, data quantity, and data quality type: number reverseCorrelation: description: >- Correlation when cause and effect are reversed. For any causal relationship, the forward correlation should exceed the reverse correlation. type: number reversePearsonCorrelationCoefficient: description: 'Example: 0.63628232030415' format: double type: number shareUserMeasurements: description: 'Example: 1' type: boolean significanceExplanation: description: >- Using a two-tailed t-test with alpha = 0.05, it was determined that the change... type: string significantDifference: description: 'Example: 1' type: boolean statisticalSignificance: description: A function of the effect size and sample size type: string strengthLevel: description: 'weak, moderate, strong' type: string strongestPearsonCorrelationCoefficient: description: 'Example: 0.613' format: double type: number studyAbstract: description: These data suggest with a high degree of confidence... type: string studyBackground: description: >- In order to reduce suffering through the advancement of human knowledge... type: string studyDesign: description: This study is based on data donated by one user... type: string studyLimitations: description: >- As with any human experiment, it was impossible to control for all potentially confounding variables... type: string studyLinkDynamic: description: Url for the interactive study within the web app type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: Url for sharing the study on Facebook type: string studyLinkGoogle: description: Url for sharing the study on Google+ type: string studyLinkStatic: description: Url for sharing the statically rendered study on social media type: string studyLinkTwitter: description: Url for sharing the study on Twitter type: string studyObjective: description: The objective of this study is to determine... type: string studyResults: description: This analysis suggests that... type: string studyTitle: description: N1 Study HIGHER Remeron predicts HIGHER Overall Mood type: string timestamp: description: Time at which correlation was calculated type: number tValue: description: 'Example: 9.6986079652717' format: double type: number updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. format: date-time type: string updatedTime: description: 'Example: 2017-05-06 15:40:38' format: date-time type: string userId: description: 'Example: 230' type: integer userVote: description: User Vote type: number valuePredictingHighOutcome: description: >- cause value that predicts an above average effect value (in default unit for cause variable) type: number valuePredictingHighOutcomeExplanation: description: 'Overall Mood, on average, 34% HIGHER after around 3.98mg Remeron' type: string valuePredictingLowOutcome: description: >- cause value that predicts a below average effect value (in default unit for cause variable) type: number valuePredictingLowOutcomeExplanation: description: 'Overall Mood, on average, 4% LOWER after around 0mg Remeron' type: string vote: description: 'Example: ' type: string required: - cause - correlationCoefficient - durationOfAction - effect - numberOfPairs - onsetDelay - timestamp AggregatedCorrelationArray: items: $ref: '#/definitions/AggregatedCorrelation' type: array Animation: properties: duration: description: 'Example: 0' type: integer required: - duration Button: properties: link: description: 'Example: https://local.quantimo.do' type: string text: description: 'Example: Start Tracking' type: string required: - link - text Chart: properties: animation: $ref: '#/definitions/Animation' chartConfig: $ref: '#/definitions/ChartConfig' chartId: description: 'Example: correlationScatterPlot' type: string chartTitle: description: >- Example: Reference And Learning Hours following Barometric Pressure (R = 0.147) type: string explanation: description: >- Example: The chart above indicates that an increase in Barometric Pressure is usually followed by an increase in Reference And Learning Hours. type: string height: description: 'Example: 300' type: integer renderTo: description: 'Example: BarContainer' type: string type: description: 'Example: scatter' type: string zoomType: description: 'Example: xy' type: string required: - animation - chartConfig - chartId - chartTitle - explanation - height - renderTo - type - zoomType ChartConfig: properties: loading: description: 'Example: false' type: boolean options: $ref: '#/definitions/Option' series: items: $ref: '#/definitions/Series' type: array subtitle: $ref: '#/definitions/Subtitle' title: $ref: '#/definitions/Title' xAxis: $ref: '#/definitions/XAxi' yAxis: $ref: '#/definitions/YAxi' required: - loading - options - series - subtitle - title - xAxis - yAxis ChartStyle: properties: background: description: 'Example: url(/res/loading3.gif) no-repeat center' type: string required: - background Column: properties: borderWidth: description: 'Example: 0' type: integer colorByPoint: description: 'Example: true' type: boolean enableMouseTracking: description: 'Example: true' type: boolean pointPadding: description: 'Example: 0.2' format: double type: number pointWidth: description: 'Example: 33.333333333333' format: double type: number required: - borderWidth - colorByPoint - enableMouseTracking - pointPadding - pointWidth CommonResponse: properties: data: $ref: '#/definitions/GetStudyDataResponse' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success type: object CommonVariable: properties: alias: description: 'Example: ' type: string availableUnits: items: $ref: '#/definitions/Unit' type: array category: description: 'Example: Sleep' type: string causeOnly: description: >- A value of 1 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. type: integer chartsLinkDynamic: description: >- Example: https://local.quantimo.do/ionic/Modo/www/#/app/charts/Barometric%20Pressure?variableName=Barometric%20Pressure&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Fenvironment.png type: string chartsLinkEmail: description: >- Example: mailto:?subject=Check%20out%20my%20Barometric%20Pressure%20data%21&body=See%20my%20Barometric%20Pressure%20history%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DBarometric%2520Pressure%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Fenvironment.png%0A%0AHave%20a%20great%20day! type: string chartsLinkFacebook: description: >- Example: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DBarometric%2520Pressure%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Fenvironment.png type: string chartsLinkGoogle: description: >- Example: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DBarometric%2520Pressure%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Fenvironment.png type: string chartsLinkStatic: description: >- Example: https://local.quantimo.do/api/v2/charts?variableName=Barometric%20Pressure&userId=230&pngUrl=https%3A%2F%2Fapp.quantimo.do%2Fionic%2FModo%2Fwww%2Fimg%2Fvariable_categories%2Fenvironment.png type: string chartsLinkTwitter: description: >- Example: https://twitter.com/home?status=Check%20out%20my%20Barometric%20Pressure%20data%21%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fcharts%3FvariableName%3DBarometric%2520Pressure%26userId%3D230%26pngUrl%3Dhttps%253A%252F%252Fapp.quantimo.do%252Fionic%252FModo%252Fwww%252Fimg%252Fvariable_categories%252Fenvironment.png%20%40quantimodo type: string childUserTagVariables: $ref: '#/definitions/UserVariableArray' clientId: description: 'Example: local' type: string combinationOperation: description: >- Way to aggregate measurements over time. Options are "MEAN" or "SUM". SUM should be used for things like minutes of exercise. If you use MEAN for exercise, then a person might exercise more minutes in one day but add separate measurements that were smaller. So when we are doing correlational analysis, we would think that the person exercised less that day even though they exercised more. Conversely, we must use MEAN for things such as ratings which cannot be SUMMED. enum: - MEAN - SUM type: string commonAlias: description: 'Example: Mood_(psychology)' type: string commonTaggedVariables: $ref: '#/definitions/CommonVariableArray' commonTagVariables: $ref: '#/definitions/CommonVariableArray' commonVariableMostCommonConnectorId: description: 'Example: 13' type: integer commonVariableUpdatedAt: description: 'Example: 2017-07-30 20:47:38' format: date-time type: string createdAt: description: 'Example: 2014-10-23 03:41:06' format: date-time type: string dataSource: $ref: '#/definitions/DataSource' highcharts: $ref: '#/definitions/HighchartArray' unitAbbreviatedName: description: Abbreviated name of the default unit for the variable type: string unitCategoryId: description: 'Example: 1' type: integer unitCategoryName: description: 'Example: Duration' type: string unitId: description: Id of the default unit for the variable type: integer unitName: description: 'Example: Hours' type: string description: description: 'Example: positive' type: string durationOfAction: description: >- The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. type: integer durationOfActionInHours: description: 'Example: 168' type: integer earliestFillingTime: description: 'Example: 1362099600' type: integer earliestMeasurementTime: description: Earliest measurement time type: integer earliestSourceTime: description: 'Example: 1334473200' type: integer experimentEndTime: description: 'Example: ' format: date-time type: string experimentEndTimeSeconds: description: 'Example: ' format: date-time type: string experimentEndTimeString: description: 'Example: ' format: date-time type: string experimentStartTime: description: 'Example: ' format: date-time type: string experimentStartTimeSeconds: description: 'Example: ' format: date-time type: string experimentStartTimeString: description: 'Example: ' format: date-time type: string fillingType: description: 'Example: ' type: string fillingValue: description: >- 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. format: double type: number id: description: Variable ID type: integer imageUrl: description: '' type: string informationalUrl: description: 'Example: ' type: string ingredientOfUserTagVariables: $ref: '#/definitions/UserVariableArray' ingredientUserTagVariables: $ref: '#/definitions/UserVariableArray' inputType: description: 'Example: slider' type: string ionIcon: description: '' type: string joinedUserTagVariables: $ref: '#/definitions/UserVariableArray' joinedVariables: description: Array of Variables that are joined with this Variable items: $ref: '#/definitions/CommonVariable' type: array joinWith: description: >- The Variable this Variable should be joined with. If the variable is joined with some other variable then it is not shown to user in the list of variables. type: string kurtosis: description: 'Example: 10.764488721491' format: double type: number lastOriginalUnitId: description: 'Example: 47' type: integer lastOriginalValue: description: 'Example: 100900' format: double type: number lastProcessedDailyValue: description: 'Example: 100900' format: double type: number lastSource: description: Last source type: integer lastSuccessfulUpdateTime: description: 'Example: 2017-02-08 17:43:01' format: date-time type: string lastUnit: description: Last unit type: string lastUnitId: description: 'Example: 47' type: integer lastValue: description: Last value type: integer latestFillingTime: description: 'Example: 1501722000' type: integer latestMeasurementTime: description: Latest measurement time type: integer latestSourceTime: description: 'Example: 1501722000' type: integer latestUserMeasurementTime: description: 'Example: 1501722000' type: integer manualTracking: description: 'Example: 1' type: boolean maximumAllowedValue: description: >- The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. format: double type: number maximumRecordedValue: description: 'Example: 104700' format: double type: number mean: description: 'Example: 2202.3886251393' format: double type: number measurementsAtLastAnalysis: description: 'Example: 9795' type: integer median: description: 'Example: 2255.9284755781' format: double type: number minimumAllowedValue: description: >- The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. format: double type: number minimumRecordedValue: description: 'Example: 1008.74' format: double type: number mostCommonConnectorId: description: 'Example: 7' type: integer mostCommonOriginalUnitId: description: 'Example: 2' type: integer mostCommonUnit: description: Most common unit type: string mostCommonValue: description: Most common value type: integer name: description: User-defined variable display name. type: string numberOfAggregateCorrelationsAsCause: description: 'Example: 386' type: integer numberOfAggregateCorrelationsAsEffect: description: 'Example: 2074' type: integer numberOfChanges: description: 'Example: 1317' type: integer numberOfCorrelations: description: Number of correlations type: integer numberOfMeasurements: description: 'Example: 308554' type: integer numberOfProcessedDailyMeasurements: description: 'Example: 1364' type: integer numberOfRawMeasurements: description: Number of measurements type: integer numberOfTrackingReminders: description: 'Example: 6' type: integer numberOfUniqueDailyValues: description: 'Example: 283' type: integer numberOfUniqueValues: description: 'Example: 74' type: integer numberOfUserCorrelationsAsCause: description: 'Example: 155' type: integer numberOfUserCorrelationsAsEffect: description: 'Example: 0' type: integer numberOfUserVariables: description: 'Example: 307' type: integer onsetDelay: description: >- The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes. type: integer onsetDelayInHours: description: 'Example: 0' type: integer outcome: description: >- Outcome variables (those with `outcome` == 1) are 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. type: integer outcomeOfInterest: description: 'Example: 0' type: integer parent: description: Id of the parent variable if this variable has any parent type: integer parentId: description: 'Example: ' type: string parentUserTagVariables: $ref: '#/definitions/UserVariableArray' pngPath: description: 'Example: img/variable_categories/sleep.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/sleep.png type: string predictorOfInterest: description: 'Example: 0' type: integer price: description: 'Example: ' type: string productUrl: description: 'Example: ' type: string public: description: 'Example: 1' type: boolean rawMeasurementsAtLastAnalysis: description: >- The number of measurements that a given user had for this variable the last time a correlation calculation was performed. Generally correlation values are only updated once the current number of measurements for a variable is more than 10% greater than the rawMeasurementsAtLastAnalysis. This avoids a computationally-demanding recalculation when there's not enough new data to make a significant difference in the correlation. type: integer secondMostCommonValue: description: 'Example: 8' format: double type: number secondToLastValue: description: 'Example: 101800' format: double type: number shareUserMeasurements: description: 'Example: false' type: boolean skewness: description: 'Example: 0.2461351905455' format: double type: number sources: description: >- Comma-separated list of source names to limit variables to those sources type: string standardDeviation: description: 'Example: 1840.535129803' format: double type: number status: description: 'Example: UPDATED' type: string subVariables: description: Array of Variables that are sub variables to this Variable items: $ref: '#/definitions/CommonVariable' type: array svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/sleep.svg type: string thirdMostCommonValue: description: 'Example: 7' format: double type: number thirdToLastValue: description: 'Example: 102000' format: double type: number updated: description: When this variable or its settings were last updated type: integer updatedAt: description: 'Example: 2017-07-31 03:57:06' format: date-time type: string userId: description: 'Example: 230' type: integer valence: description: 'Example: positive' type: string variableCategoryId: description: 'Example: 6' type: integer variableCategoryImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Household/sleeping_in_bed-96.png type: string variableCategoryName: description: >- Variable category like Mood, Sleep, Physical Activity, Treatment, Symptom, etc. type: string variableFillingValue: description: 'Example: -1' format: double type: number variableId: description: 'Example: 96380' type: integer variableName: description: 'Example: Sleep Duration' type: string variance: description: 'Example: 115947037.40816' format: double type: number wikipediaTitle: description: 'Example: ' type: string required: - alias - availableUnits - causeOnly - chartsLinkDynamic - chartsLinkEmail - chartsLinkFacebook - chartsLinkGoogle - chartsLinkStatic - chartsLinkTwitter - childUserTagVariables - clientId - combinationOperation - commonTagVariables - commonTaggedVariables - commonVariableMostCommonConnectorId - commonVariableUpdatedAt - dataSource - unitAbbreviatedName - unitId - durationOfAction - earliestFillingTime - earliestMeasurementTime - earliestSourceTime - experimentEndTime - experimentEndTimeSeconds - experimentEndTimeString - experimentStartTime - experimentStartTimeSeconds - experimentStartTimeString - fillingType - fillingValue - informationalUrl - ingredientOfUserTagVariables - ingredientUserTagVariables - joinWith - joinedUserTagVariables - joinedVariables - lastOriginalUnitId - lastOriginalValue - lastProcessedDailyValue - lastSource - lastSuccessfulUpdateTime - lastUnit - lastUnitId - lastValue - latestFillingTime - latestMeasurementTime - latestSourceTime - latestUserMeasurementTime - maximumAllowedValue - maximumRecordedValue - measurementsAtLastAnalysis - minimumAllowedValue - minimumRecordedValue - mostCommonUnit - mostCommonValue - name - numberOfChanges - numberOfCorrelations - numberOfProcessedDailyMeasurements - numberOfRawMeasurements - numberOfUniqueDailyValues - numberOfUserCorrelationsAsCause - numberOfUserCorrelationsAsEffect - onsetDelay - onsetDelayInHours - outcome - outcomeOfInterest - parent - parentId - parentUserTagVariables - predictorOfInterest - price - productUrl - rawMeasurementsAtLastAnalysis - secondToLastValue - shareUserMeasurements - sources - status - subVariables - thirdToLastValue - updated - userId - variableCategoryName - variableFillingValue - variableId - wikipediaTitle CommonVariableArray: items: $ref: '#/definitions/CommonVariable' type: array Connector: properties: affiliate: description: 'Example: false' type: boolean buttons: items: $ref: '#/definitions/Button' type: array clientId: description: 'Example: ghostInspector' type: string connected: description: True if the authenticated user has this connector enabled type: string connectError: description: 'Example: Your token is expired. Please re-connect' type: string connectInstructions: description: URL and parameters used when connecting to a service type: string connectorClientId: description: 'Example: 225078261031461' type: string connectorId: description: 'Example: 8' type: integer connectStatus: description: 'Example: CONNECTED' type: string createdAt: description: 'Example: 2000-01-01 00:00:00' format: date-time type: string defaultVariableCategoryName: description: 'Example: Social Interactions' type: string displayName: description: Connector pretty display name type: string enabled: description: 'Example: 1' type: integer getItUrl: description: URL to a site where one can get this device or application type: string id: description: Connector ID number type: integer image: description: URL to the image of the connector logo type: string imageHtml: description: >- Example: Facebook type: string lastSuccessfulUpdatedAt: description: 'Example: 2017-07-31 10:10:34' format: date-time type: string lastUpdate: description: Epoch timestamp of last sync type: integer linkedDisplayNameHtml: description: 'Example: Facebook' type: string longDescription: description: >- Example: Facebook is a social networking website where users may create a personal profile, add other users as friends, and exchange messages. type: string message: description: 'Example: Got 412 new measurements on 2017-07-31 10:10:34' type: string name: description: Connector lowercase system name type: string oauth: description: 'Example: {}' type: object scopes: items: $ref: '#/definitions/Scope' type: array shortDescription: description: >- Example: Tracks social interaction. QuantiModo requires permission to access your Facebook "user likes" and "user posts". type: string totalMeasurementsInLastUpdate: description: Number of measurements obtained during latest update type: integer updatedAt: description: 'Example: 2017-07-31 10:10:34' format: date-time type: string updateRequestedAt: description: 'Example: 2017-07-18 05:16:31' format: date-time type: string updateStatus: description: 'Example: UPDATED' type: string userId: description: 'Example: 230' type: integer required: - connectInstructions - connected - displayName - getItUrl - id - image - lastUpdate - name - totalMeasurementsInLastUpdate ConnectorArray: items: $ref: '#/definitions/Connector' type: array ConnectorInstruction: properties: parameters: description: parameters array items: type: string type: array url: description: url type: string usePopup: description: usePopup type: boolean ConversionStep: properties: operation: description: ADD or MULTIPLY enum: - ADD - MULTIPLY type: string value: description: This specifies the order of conversion steps starting with 0 format: double type: number required: - operation - value Correlation: properties: averageDailyHighCause: description: 'Example: 4.19' format: double type: number averageDailyLowCause: description: 'Example: 1.97' format: double type: number averageEffect: description: 'Example: 3.0791054117396' format: double type: number averageEffectFollowingHighCause: description: 'Example: 3.55' format: double type: number averageEffectFollowingHighCauseExplanation: description: >- Example: Overall Mood is 3.55/5 (15% higher) on average after days with around 4.19/5 Sleep Quality type: string averageEffectFollowingLowCause: description: 'Example: 2.65' format: double type: number averageEffectFollowingLowCauseExplanation: description: >- Example: Overall Mood is 2.65/5 (14% lower) on average after days with around 1.97/5 Sleep Quality type: string averageForwardPearsonCorrelationOverOnsetDelays: description: 'Example: 0.396' format: double type: number averageReversePearsonCorrelationOverOnsetDelays: description: 'Example: 0.453667' format: double type: number averageVote: description: 'Example: 0.9855' type: string causeChanges: description: 'Example: 164' type: integer causeDataSource: $ref: '#/definitions/DataSource' causeUserVariableShareUserMeasurements: description: 'Example: 1' type: integer causeVariableCategoryId: description: 'Example: 6' type: integer causeVariableCategoryName: description: 'Example: Sleep' type: string causeVariableCombinationOperation: description: 'Example: MEAN' type: string causeVariableUnitAbbreviatedName: description: 'Example: /5' type: string causeVariableUnitId: description: 'Example: 10' type: integer causeVariableUnitName: description: 'Example: 1 to 5 Rating' type: string causeVariableId: description: 'Example: 1448' type: integer causeVariableImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Household/sleeping_in_bed-96.png type: string causeVariableIonIcon: description: 'Example: ion-ios-cloudy-night-outline' type: string causeVariableMostCommonConnectorId: description: 'Example: 6' type: integer causeVariableName: description: 'Example: Sleep Quality' type: string confidenceInterval: description: 'Example: 0.14344467795996' format: double type: number confidenceLevel: description: 'Example: high' type: string correlationCoefficient: description: 'Example: 0.538' format: double type: number correlationIsContradictoryToOptimalValues: description: 'Example: false' type: boolean createdAt: description: 'Example: 2016-12-28 20:47:30' format: date-time type: string criticalTValue: description: 'Example: 1.646' format: double type: number dataAnalysis: description: >- Example: It was assumed that 0 hours would pass before a change in Sleep Quality would produce an observable change in Overall Mood. It was assumed that Sleep Quality could produce an observable change in Overall Mood for as much as 7 days after the stimulus event. type: string dataSources: description: >- Example: Sleep Quality data was primarily collected using Up by Jawbone. UP by Jawbone is a wristband and app that tracks how you sleep, move and eat and then helps you use that information to feel your best.
Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string dataSourcesParagraphForCause: description: >- Example: Sleep Quality data was primarily collected using Up by Jawbone. UP by Jawbone is a wristband and app that tracks how you sleep, move and eat and then helps you use that information to feel your best. type: string dataSourcesParagraphForEffect: description: >- Example: Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string direction: description: 'Example: higher' type: string durationOfAction: description: 'Example: 604800' type: integer durationOfActionInHours: description: 'Example: 168' type: integer effectChanges: description: 'Example: 193' type: integer effectDataSource: $ref: '#/definitions/DataSource' effectSize: description: 'Example: moderately positive' type: string effectUnit: description: 'Example: /5' type: string effectUserVariableShareUserMeasurements: description: 'Example: 1' type: integer effectVariableCategoryId: description: 'Example: 1' type: integer effectVariableCategoryName: description: 'Example: Emotions' type: string effectVariableCombinationOperation: description: 'Example: MEAN' type: string effectVariableCommonAlias: description: 'Example: Mood_(psychology)' type: string effectVariableUnitAbbreviatedName: description: 'Example: /5' type: string effectVariableUnitId: description: 'Example: 10' type: integer effectVariableUnitName: description: 'Example: 1 to 5 Rating' type: string effectVariableId: description: 'Example: 1398' type: integer effectVariableImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string effectVariableIonIcon: description: 'Example: ion-happy-outline' type: string effectVariableMostCommonConnectorId: description: 'Example: 10' type: integer effectVariableName: description: 'Example: Overall Mood' type: string experimentEndTime: description: 'Example: 2014-07-30 12:50:00' format: date-time type: string experimentStartTime: description: 'Example: 2012-05-06 21:15:00' format: date-time type: string forwardSpearmanCorrelationCoefficient: description: 'Example: 0.528359' format: double type: number gaugeImage: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship.png type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship-200-200.png type: string imageUrl: description: >- Example: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-moderately-positive-relationship_sleep_emotions_logo_background.png type: string instructionsForCause: description: >- Example: Obtain Up by Jawbone and use it to record your Sleep Quality. Once you have a Up by Jawbone account, connect your Up by Jawbone account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffect: description: >- Example: Obtain QuantiModo and use it to record your Overall Mood. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string numberOfPairs: description: 'Example: 298' type: integer onsetDelay: description: 'Example: 0' type: integer onsetDelayInHours: description: 'Example: 0' type: integer onsetDelayWithStrongestPearsonCorrelation: description: 'Example: -86400' type: integer onsetDelayWithStrongestPearsonCorrelationInHours: description: 'Example: -24' type: integer optimalPearsonProduct: description: 'Example: 0.68582816186982' format: double type: number outcomeFillingValue: description: 'Example: -1' type: integer outcomeMaximumAllowedValue: description: 'Example: 23' format: double type: number outcomeMinimumAllowedValue: description: 'Example: 0.1' format: double type: number pearsonCorrelationWithNoOnsetDelay: description: 'Example: 0.477' format: double type: number predictivePearsonCorrelation: description: 'Example: 0.538' format: double type: number predictivePearsonCorrelationCoefficient: description: 'Example: 0.538' format: double type: number predictorDataSources: description: 'Example: RescueTime' type: string predictorExplanation: description: 'Example: Sleep Quality Predicts Higher Overall Mood' type: string predictorFillingValue: description: 'Example: -1' type: integer predictorMaximumAllowedValue: description: 'Example: 200' format: double type: number predictorMinimumAllowedValue: description: 'Example: 30' format: double type: number predictsHighEffectChange: description: 'Example: 17' type: integer predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 17% ' type: string predictsLowEffectChange: description: 'Example: -11' type: integer predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 11% ' type: string pValue: description: 'Example: 0.39628900511586' format: double type: number qmScore: description: 'Example: 0.528' format: double type: number reversePearsonCorrelationCoefficient: description: 'Example: 0.01377184270977' format: double type: number shareUserMeasurements: description: 'Example: 1' type: boolean significanceExplanation: description: >- Example: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Overall Mood is statistically significant at 95% confidence interval. type: string significantDifference: description: 'Example: 1' type: boolean statisticalSignificance: description: 'Example: 0.9813' format: double type: number strengthLevel: description: 'Example: moderate' type: string strongestPearsonCorrelationCoefficient: description: 'Example: 0.613' format: double type: number studyAbstract: description: >- Example: Your data suggests with a high degree of confidence (p=0) that Sleep Quality (Sleep) has a moderately positive predictive relationship (R=0.538) with Overall Mood (Emotions). The highest quartile of Overall Mood measurements were observed following an average 4.14/5 Sleep Quality. The lowest quartile of Overall Mood measurements were observed following an average 3.03/5 Sleep Quality. type: string studyDesign: description: >- Example: This study is based on data donated by one QuantiModo user. Thus, the study design is consistent with an n=1 observational natural experiment. type: string studyLimitations: description: >- Example: As with any human experiment, it was impossible to control for all potentially confounding variables. Correlation does not necessarily imply correlation. We can never know for sure if one factor is definitely the cause of an outcome. However, lack of correlation definitely implies the lack of a causal relationship. Hence, we can with great confidence rule out non-existent relationships. For instance, if we discover no relationship between mood and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship.

We can also take advantage of several characteristics of time series data from many subjects to infer the likelihood of a causal relationship if we do find a correlational relationship. The criteria for causation are a group of minimal conditions necessary to provide adequate evidence of a causal relationship between an incidence and a possible consequence. The list of the criteria is as follows:
1. Strength (effect size): A small association does not mean that there is not a causal effect, though the larger the association, the more likely that it is causal.
2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect.
3. Specificity: Causation is likely if a very specific population at a specific site and disease with no other likely explanation. The more specific an association between a factor and an effect is, the bigger the probability of a causal relationship.
4. Temporality: The effect has to occur after the cause (and if there is an expected delay between the cause and expected effect, then the effect must occur after that delay).
5. Biological gradient: Greater exposure should generally lead to greater incidence of the effect. However, in some cases, the mere presence of the factor can trigger the effect. In other cases, an inverse proportion is observed: greater exposure leads to lower incidence.
6. Plausibility: A plausible mechanism between cause and effect is helpful.
7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect.
8. Experiment: "Occasionally it is possible to appeal to experimental evidence".
9. Analogy: The effect of similar factors may be considered.

The confidence in a causal relationship is bolstered by the fact that time-precedence was taken into account in all calculations. Furthermore, in accordance with the law of large numbers (LLN), the predictive power and accuracy of these results will continually grow over time. 298 paired data points were used in this analysis. Assuming that the relationship is merely coincidental, as the participant independently modifies their Sleep Quality values, the observed strength of the relationship will decline until it is below the threshold of significance. To it another way, in the case that we do find a spurious correlation, suggesting that banana intake improves mood for instance, one will likely increase their banana intake. Due to the fact that this correlation is spurious, it is unlikely that you will see a continued and persistent corresponding increase in mood. So over time, the spurious correlation will naturally dissipate.Furthermore, it will be very enlightening to aggregate this data with the data from other participants with similar genetic, diseasomic, environmentomic, and demographic profiles. type: string studyLinkDynamic: description: >- Example: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230 type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: >- Example: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230 type: string studyLinkGoogle: description: >- Example: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230 type: string studyLinkStatic: description: >- Example: https://local.quantimo.do/api/v2/study?causeVariableName=Sleep%20Quality&effectVariableName=Overall%20Mood&userId=230 type: string studyLinkTwitter: description: >- Example: https://twitter.com/home?status=Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%20%40quantimodo type: string studyObjective: description: >- Example: The objective of this study is to determine the nature of the relationship (if any) between the Sleep Quality and the Overall Mood. Additionally, we attempt to determine the Sleep Quality values most likely to produce optimal Overall Mood values. type: string studyResults: description: >- Example: This analysis suggests that higher Sleep Quality (Sleep) generally predicts higher Overall Mood (p = 0). Overall Mood is, on average, 17% higher after around 4.14 Sleep Quality. After an onset delay of 168 hours, Overall Mood is, on average, 11% lower than its average over the 168 hours following around 3.03 Sleep Quality. 298 data points were used in this analysis. The value for Sleep Quality changed 164 times, effectively running 82 separate natural experiments. The top quartile outcome values are preceded by an average 4.14 /5 of Sleep Quality. The bottom quartile outcome values are preceded by an average 3.03 /5 of Sleep Quality. Forward Pearson Correlation Coefficient was 0.538 (p=0, 95% CI 0.395 to 0.681 onset delay = 0 hours, duration of action = 168 hours) . The Reverse Pearson Correlation Coefficient was 0 (P=0, 95% CI -0.143 to 0.143, onset delay = -0 hours, duration of action = -168 hours). When the Sleep Quality value is closer to 4.14 /5 than 3.03 /5, the Overall Mood value which follows is, on average, 17% percent higher than its typical value. When the Sleep Quality value is closer to 3.03 /5 than 4.14 /5, the Overall Mood value which follows is 0% lower than its typical value. Overall Mood is 3.55/5 (15% higher) on average after days with around 4.19/5 Sleep Quality Overall Mood is 2.65/5 (14% lower) on average after days with around 1.97/5 Sleep Quality type: string studyTitle: description: 'Example: N1 Study: Sleep Quality Predicts Higher Overall Mood' type: string timestamp: description: 'Example: 1494085127' type: integer tValue: description: 'Example: 9.6986079652717' format: double type: number updatedAt: description: 'Example: 2017-05-06 15:40:38' format: date-time type: string userId: description: 'Example: 230' type: integer userVote: description: 'Example: 1' type: integer valuePredictingHighOutcome: description: 'Example: 4.14' format: double type: number valuePredictingHighOutcomeExplanation: description: >- Example: Overall Mood, on average, 17% higher after around 4.14/5 Sleep Quality type: string valuePredictingLowOutcome: description: 'Example: 3.03' format: double type: number valuePredictingLowOutcomeExplanation: description: >- Example: Overall Mood, on average, 11% lower after around 3.03/5 Sleep Quality type: string required: - averageDailyHighCause - averageDailyLowCause - averageEffect - averageEffectFollowingHighCause - averageEffectFollowingHighCauseExplanation - averageEffectFollowingLowCause - averageEffectFollowingLowCauseExplanation - averageForwardPearsonCorrelationOverOnsetDelays - averageReversePearsonCorrelationOverOnsetDelays - averageVote - causeChanges - causeUserVariableShareUserMeasurements - causeVariableCategoryId - causeVariableCategoryName - causeVariableCombinationOperation - causeVariableUnitAbbreviatedName - causeVariableUnitId - causeVariableUnitName - causeVariableId - causeVariableImageUrl - causeVariableIonIcon - causeVariableMostCommonConnectorId - causeVariableName - confidenceInterval - confidenceLevel - correlationCoefficient - createdAt - criticalTValue - dataAnalysis - dataSources - dataSourcesParagraphForCause - dataSourcesParagraphForEffect - direction - durationOfAction - durationOfActionInHours - effectChanges - effectSize - effectUnit - effectUserVariableShareUserMeasurements - effectVariableCategoryId - effectVariableCategoryName - effectVariableCombinationOperation - effectVariableCommonAlias - effectVariableUnitAbbreviatedName - effectVariableUnitId - effectVariableUnitName - effectVariableId - effectVariableImageUrl - effectVariableIonIcon - effectVariableMostCommonConnectorId - effectVariableName - experimentEndTime - experimentStartTime - forwardSpearmanCorrelationCoefficient - gaugeImage - gaugeImageSquare - imageUrl - instructionsForCause - instructionsForEffect - numberOfPairs - onsetDelay - onsetDelayInHours - onsetDelayWithStrongestPearsonCorrelation - onsetDelayWithStrongestPearsonCorrelationInHours - optimalPearsonProduct - outcomeFillingValue - pearsonCorrelationWithNoOnsetDelay - predictivePearsonCorrelation - predictivePearsonCorrelationCoefficient - predictorDataSources - predictorExplanation - predictorFillingValue - predictorMaximumAllowedValue - predictorMinimumAllowedValue - predictsHighEffectChange - predictsHighEffectChangeSentenceFragment - predictsLowEffectChange - predictsLowEffectChangeSentenceFragment - qmScore - reversePearsonCorrelationCoefficient - shareUserMeasurements - significanceExplanation - significantDifference - statisticalSignificance - strengthLevel - strongestPearsonCorrelationCoefficient - studyAbstract - studyDesign - studyLimitations - studyLinkDynamic - studyLinkEmail - studyLinkFacebook - studyLinkGoogle - studyLinkStatic - studyLinkTwitter - studyObjective - studyResults - studyTitle - tValue - timestamp - updatedAt - userId - userVote - valuePredictingHighOutcome - valuePredictingHighOutcomeExplanation - valuePredictingLowOutcome - valuePredictingLowOutcomeExplanation CorrelationArray: items: $ref: '#/definitions/Correlation' type: array Credit: properties: enabled: description: 'Example: false' type: boolean required: - enabled DataSource: properties: affiliate: description: 'Example: true' type: boolean connectorClientId: description: >- Example: ba7d0c12432650e23b3ce924ae2d21e2ff59e7e4e28650759633700af7ed0a30 type: string defaultVariableCategoryName: description: 'Example: Foods' type: string displayName: description: 'Example: QuantiModo' type: string enabled: description: 'Example: 0' type: integer getItUrl: description: 'Example: https://quantimo.do' type: string id: description: 'Example: 72' type: integer image: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/logos/quantimodo-logo-qm-rainbow-200-200.png type: string imageHtml: description: >- Example: QuantiModo type: string linkedDisplayNameHtml: description: 'Example: QuantiModo' type: string longDescription: description: >- Example: QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string name: description: 'Example: quantimodo' type: string shortDescription: description: 'Example: Tracks anything' type: string required: - affiliate - connectorClientId - defaultVariableCategoryName - displayName - enabled - getItUrl - id - image - imageHtml - linkedDisplayNameHtml - longDescription - name - shortDescription Explanation: properties: description: description: >- Example: These factors are most predictive of Overall Mood based on your own data. type: string image: $ref: '#/definitions/Image' ionIcon: description: 'Example: ion-ios-person' type: string startTracking: $ref: '#/definitions/ExplanationStartTracking' title: description: 'Example: Top Predictors of Overall Mood' type: string required: - description - image - ionIcon - startTracking - title ExplanationStartTracking: properties: button: $ref: '#/definitions/Button' description: description: >- Example: The more data I have the more accurate your results will be so track regularly! type: string title: description: 'Example: Improve Accuracy' type: string required: - button - description - title GetAggregatedCorrelationsResponse: properties: aggregateQMScore: description: 'Example: 0.26756148446253' format: double type: number averageDailyHighCause: description: 'Example: 5' format: double type: number averageDailyLowCause: description: 'Example: 1' format: double type: number averageEffect: description: 'Example: 3' format: double type: number averageEffectFollowingHighCause: description: 'Example: 5' format: double type: number averageEffectFollowingHighCauseExplanation: description: >- Example: Video Activities is 5h (67% higher) on average after days with around 5 h Very Distracting Time type: string averageEffectFollowingLowCause: description: 'Example: 3' format: double type: number averageEffectFollowingLowCauseExplanation: description: 'Example: ' type: string averageVote: description: 'Example: ' type: string causeChanges: description: 'Example: 2984' type: integer causeVariableCategoryId: description: 'Example: 12' type: integer causeVariableCategoryName: description: 'Example: Work' type: string causeVariableCombinationOperation: description: 'Example: SUM' type: string causeVariableCommonAlias: description: 'Example: ' type: string causeVariableUnitAbbreviatedName: description: 'Example: h' type: string causeVariableUnitId: description: 'Example: 34' type: integer causeVariableUnitName: description: 'Example: Hours' type: string causeVariableId: description: 'Example: 5956878' type: integer causeVariableImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Business/work-96.png' type: string causeVariableInformationalUrl: description: 'Example: ' type: string causeVariableIonIcon: description: 'Example: ion-laptop' type: string causeVariableMostCommonConnectorId: description: 'Example: 11' type: integer causeVariableName: description: 'Example: Very Distracting Time' type: string causeVariableProductUrl: description: 'Example: ' type: string confidenceInterval: description: 'Example: 0.79069937144827' format: double type: number confidenceLevel: description: 'Example: low' type: string correlationCoefficient: description: 'Example: 0.3538' format: double type: number createdAt: description: 'Example: 2017-08-01 21:49:11' format: date-time type: string criticalTValue: description: 'Example: 1.6604761904762' format: double type: number direction: description: 'Example: higher' type: string durationOfAction: description: 'Example: 604800' type: integer durationOfActionInHours: description: 'Example: 168' type: integer effectChanges: description: 'Example: 2708' type: integer effectSize: description: 'Example: moderately positive' type: string effectUnit: description: 'Example: h' type: string effectVariableCategoryId: description: 'Example: 14' type: integer effectVariableCategoryName: description: 'Example: Activity' type: string effectVariableCombinationOperation: description: 'Example: SUM' type: string effectVariableCommonAlias: description: 'Example: ' type: string effectVariableUnitAbbreviatedName: description: 'Example: h' type: string effectVariableUnitId: description: 'Example: 34' type: integer effectVariableUnitName: description: 'Example: Hours' type: string effectVariableId: description: 'Example: 5956912' type: integer effectVariableImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Sports/football-96.png' type: string effectVariableInformationalUrl: description: 'Example: ' type: string effectVariableIonIcon: description: 'Example: ion-ios-body-outline' type: string effectVariableMostCommonConnectorId: description: 'Example: 11' type: integer effectVariableName: description: 'Example: Video Activities' type: string effectVariableProductUrl: description: 'Example: ' type: string forwardPearsonCorrelationCoefficient: description: 'Example: 0.3538' format: double type: number gaugeImage: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship.png type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship-200-200.png type: string imageUrl: description: >- Example: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-moderately-positive-relationship_work_activity_logo_background.png type: string numberOfCorrelations: description: 'Example: 21' type: integer numberOfPairs: description: 'Example: 146' type: integer numberOfUsers: description: 'Example: 21' type: integer onsetDelay: description: 'Example: 0' type: integer onsetDelayInHours: description: 'Example: 0' type: integer optimalPearsonProduct: description: 'Example: 0.20105795420291' format: double type: number perDaySentenceFragment: description: 'Example: ' type: string predictivePearsonCorrelationCoefficient: description: 'Example: 0.14597624010255' format: double type: number predictorExplanation: description: 'Example: Very Distracting Time Predicts Higher Video Activities' type: string predictsHighEffectChange: description: 'Example: 36' type: integer predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 36% ' type: string predictsLowEffectChange: description: 'Example: -16' type: integer predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 16% ' type: string pValue: description: 'Example: 0.09747619047619' format: double type: number qmScore: description: 'Example: 0.26756148446253' format: double type: number reversePearsonCorrelationCoefficient: description: 'Example: 0.2077898127704' format: double type: number significanceExplanation: description: >- Example: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Video Activities is statistically significant at 95% confidence interval. type: string significantDifference: description: 'Example: true' type: boolean statisticalSignificance: description: 'Example: 0.6614' format: double type: number strengthLevel: description: 'Example: weak' type: string studyAbstract: description: >- Example: Aggregated data from 21 suggests with a low degree of confidence (p=0.097) that Very Distracting Time (Work) has a moderately positive predictive relationship (R=0.354) with Video Activities (Activity). The highest quartile of Video Activities measurements were observed following an average 2.03h Very Distracting Time. The lowest quartile of Video Activities measurements were observed following an average 1.04h Very Distracting Time. type: string studyLinkDynamic: description: >- Example: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Very%20Distracting%20Time&effectVariableName=Video%20Activities type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Very%20Distracting%20Time%20Predicts%20Higher%20Video%20Activities&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DVery%2520Distracting%2520Time%26effectVariableName%3DVideo%2520Activities%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: >- Example: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DVery%2520Distracting%2520Time%26effectVariableName%3DVideo%2520Activities type: string studyLinkGoogle: description: >- Example: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DVery%2520Distracting%2520Time%26effectVariableName%3DVideo%2520Activities type: string studyLinkStatic: description: >- Example: https://local.quantimo.do/api/v2/study?causeVariableName=Very%20Distracting%20Time&effectVariableName=Video%20Activities type: string studyLinkTwitter: description: >- Example: https://twitter.com/home?status=Very%20Distracting%20Time%20Predicts%20Higher%20Video%20Activities%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DVery%2520Distracting%2520Time%26effectVariableName%3DVideo%2520Activities%20%40quantimodo type: string studyTitle: description: >- Example: N1 Study: Very Distracting Time Predicts Higher Video Activities type: string tValue: description: 'Example: 3.1761820531649' format: double type: number updatedAt: description: 'Example: 2017-08-01 21:50:36' format: date-time type: string userVote: description: 'Example: ' type: string valuePredictingHighOutcome: description: 'Example: 2.03' format: double type: number valuePredictingHighOutcomeExplanation: description: >- Example: Video Activities, on average, 36% higher after around 2.03 h Very Distracting Time type: string valuePredictingLowOutcome: description: 'Example: 1.04' format: double type: number valuePredictingLowOutcomeExplanation: description: >- Example: Video Activities, on average, 16% lower after around 1.04 h Very Distracting Time type: string vote: description: 'Example: ' type: string GetAggregatedCorrelationsResponseArray: items: $ref: '#/definitions/GetAggregatedCorrelationsResponse' type: array GetConnectorsResponse: properties: connectors: items: $ref: '#/definitions/Connector' type: array message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success GetCorrelationsDataResponse: properties: correlations: items: $ref: '#/definitions/Correlation' type: array explanation: $ref: '#/definitions/Explanation' required: - correlations - explanation GetCorrelationsResponse: properties: data: $ref: '#/definitions/GetCorrelationsDataResponse' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success GetMeasurementsResponse: properties: clientId: description: 'Example: pImUNsI6T5Ysd81k' type: string createdAt: description: 'Example: 2017-08-09 19:19:05' format: date-time type: string id: description: 'Example: 1060761015' type: integer inputType: description: 'Example: oneToFiveNumbers' type: string ionIcon: description: 'Example: ion-happy-outline' type: string manualTracking: description: 'Example: true' type: boolean maximumAllowedValue: description: 'Example: 5' type: integer minimumAllowedValue: description: 'Example: 1' type: integer originalUnitAbbreviatedName: description: 'Example: /5' type: string originalUnitCategoryId: description: 'Example: 5' type: integer originalUnitCategoryName: description: 'Example: Rating' type: string originalUnitId: description: 'Example: 10' type: integer originalUnitName: description: 'Example: 1 to 5 Rating' type: string originalValue: description: 'Example: 1' format: double type: number pngPath: description: 'Example: img/rating/100/numeric_rating_button_100_1.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.png type: string sourceName: description: 'Example: pImUNsI6T5Ysd81k' type: string startTimeEpoch: description: 'Example: 1502306315' type: integer startTimeString: description: 'Example: 2017-08-09T19:18:35+00:00' format: date-time type: string svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.svg type: string unitAbbreviatedName: description: 'Example: /5' type: string unitCategoryId: description: 'Example: 5' type: integer unitCategoryName: description: 'Example: Rating' type: string unitId: description: 'Example: 10' type: integer unitName: description: 'Example: 1 to 5 Rating' type: string updatedAt: description: 'Example: 2017-08-09 19:19:05' format: date-time type: string userVariableVariableCategoryId: description: 'Example: 1' type: integer userVariableVariableCategoryName: description: 'Example: Emotions' type: string value: description: 'Example: 1' format: double type: number variableCategoryId: description: 'Example: 1' type: integer variableCategoryImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string variableCategoryName: description: 'Example: Emotions' type: string variableId: description: 'Example: 5970988' type: integer variableName: description: 'Example: Unique Test Variable 1502306315' type: string GetMeasurementsResponseArray: items: $ref: '#/definitions/GetMeasurementsResponse' type: array GetPairsResponse: properties: causeMeasurement: description: 'Example: 2.0166666666667' format: double type: number causeMeasurementValue: description: 'Example: 2.0166666666667' format: double type: number effectMeasurement: description: 'Example: 4' format: double type: number effectMeasurementValue: description: 'Example: 4' format: double type: number startTimeString: description: 'Example: 2015-08-06 15:49:02' format: date-time type: string timestamp: description: 'Example: 1438876142' type: integer GetPairsResponseArray: items: $ref: '#/definitions/GetPairsResponse' type: array GetPublicVariablesResponse: properties: availableUnits: items: $ref: '#/definitions/Unit' type: array category: description: 'Example: Emotions' type: string causeOnly: description: 'Example: false' type: boolean combinationOperation: description: 'Example: MEAN' type: string commonAlias: description: 'Example: Mood_(psychology)' type: string createdAt: description: 'Example: 2015-03-05 05:01:48' format: date-time type: string unitAbbreviatedName: description: 'Example: /5' type: string unitCategoryId: description: 'Example: 5' type: integer unitCategoryName: description: 'Example: Rating' type: string unitId: description: 'Example: 10' type: integer unitName: description: 'Example: 1 to 5 Rating' type: string description: description: 'Example: positive' type: string durationOfAction: description: 'Example: 86400' type: integer durationOfActionInHours: description: 'Example: 24' type: integer id: description: 'Example: 1398' type: integer inputType: description: 'Example: happiestFaceIsFive' type: string ionIcon: description: 'Example: ion-happy-outline' type: string kurtosis: description: 'Example: 4.3527259032083' format: double type: number manualTracking: description: 'Example: true' type: boolean maximumAllowedValue: description: 'Example: 5' type: integer mean: description: 'Example: 3.1359987410015' format: double type: number median: description: 'Example: 3.1295731659047' format: double type: number minimumAllowedValue: description: 'Example: 1' type: integer mostCommonConnectorId: description: 'Example: 10' type: integer mostCommonOriginalUnitId: description: 'Example: 10' type: integer mostCommonValue: description: 'Example: 3' format: double type: number name: description: 'Example: Overall Mood' type: string numberOfAggregateCorrelationsAsCause: description: 'Example: 329' type: integer numberOfAggregateCorrelationsAsEffect: description: 'Example: 890' type: integer numberOfMeasurements: description: 'Example: 544298' type: integer numberOfRawMeasurements: description: 'Example: 544298' type: integer numberOfTrackingReminders: description: 'Example: 102' type: integer numberOfUniqueValues: description: 'Example: 7' type: integer numberOfUserVariables: description: 'Example: 4003' type: integer onsetDelay: description: 'Example: 0' type: integer onsetDelayInHours: description: 'Example: 0' type: integer outcome: description: 'Example: true' type: boolean pngPath: description: 'Example: img/variable_categories/emotions.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.png type: string public: description: 'Example: true' type: boolean secondMostCommonValue: description: 'Example: 4' format: double type: number skewness: description: 'Example: -0.23360852317166' format: double type: number standardDeviation: description: 'Example: 0.7214901744899' format: double type: number svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.svg type: string thirdMostCommonValue: description: 'Example: 2' format: double type: number updatedAt: description: 'Example: 2017-07-31 19:55:38' format: date-time type: string userVariableUnitAbbreviatedName: description: 'Example: /5' type: string userVariableUnitCategoryId: description: 'Example: 5' type: integer userVariableUnitCategoryName: description: 'Example: Rating' type: string userVariableUnitId: description: 'Example: 10' type: integer userVariableUnitName: description: 'Example: 1 to 5 Rating' type: string userVariableVariableCategoryId: description: 'Example: 1' type: integer userVariableVariableCategoryName: description: 'Example: Emotions' type: string valence: description: 'Example: positive' type: string variableCategoryId: description: 'Example: 1' type: integer variableCategoryImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string variableCategoryName: description: 'Example: Emotions' type: string variableName: description: 'Example: Overall Mood' type: string variance: description: 'Example: 22.541085893948' format: double type: number GetPublicVariablesResponseArray: items: $ref: '#/definitions/GetPublicVariablesResponse' type: array GetStudyDataResponse: properties: causeProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array causeVariable: $ref: '#/definitions/UserVariable' charts: items: $ref: '#/definitions/Chart' type: array effectProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array effectVariable: $ref: '#/definitions/UserVariable' pairs: items: $ref: '#/definitions/Pair' type: array statistics: $ref: '#/definitions/Statistic' text: description: 'Example: ' type: string user: description: 'Example: ' type: string userId: description: 'Example: 230' type: integer required: - causeProcessedDailyMeasurements - causeVariable - charts - effectProcessedDailyMeasurements - effectVariable - pairs - statistics - text - user - userId GetStudyResponse: properties: causeProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array causeVariable: $ref: '#/definitions/UserVariable' charts: items: $ref: '#/definitions/Chart' type: array data: $ref: '#/definitions/GetStudyDataResponse' effectProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array effectVariable: $ref: '#/definitions/UserVariable' highcharts: $ref: '#/definitions/HighchartArray' message: description: Message type: string pairs: items: $ref: '#/definitions/Pair' type: array pairsOfAveragesForAllUsers: items: $ref: '#/definitions/PairsOfAveragesForAllUser' type: array participantInstructions: $ref: '#/definitions/ParticipantInstruction' statistics: $ref: '#/definitions/Statistic' status: description: Status code type: integer success: type: boolean text: $ref: '#/definitions/Text' type: description: 'Example: population' type: string userCorrelations: items: $ref: '#/definitions/Correlation' type: array userId: description: 'Example: 230' type: integer userStudy: $ref: '#/definitions/UserStudy' required: - status - success GetTrackingReminderNotificationsResponse: properties: data: $ref: '#/definitions/TrackingReminderNotificationsArray' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success GetTrackingRemindersResponse: properties: availableUnits: items: $ref: '#/definitions/Unit' type: array clientId: description: 'Example: ionic' type: string combinationOperation: description: 'Example: MEAN' type: string createdAt: description: 'Example: 2016-12-25 10:28:42' format: date-time type: string data: $ref: '#/definitions/TrackingRemindersArray' unitAbbreviatedName: description: 'Example: mg' type: string unitCategoryId: description: 'Example: 3' type: integer unitCategoryName: description: 'Example: Weight' type: string unitId: description: 'Example: 7' type: integer unitName: description: 'Example: Milligrams' type: string defaultValue: description: 'Example: 500' format: double type: number fillingValue: description: 'Example: 0' type: integer firstDailyReminderTime: description: 'Example: 12:00:00' format: date-time type: string frequencyTextDescription: description: 'Example: Daily (ended 2017-02-02)' type: string frequencyTextDescriptionWithTime: description: 'Example: Daily at 09:00 AM (ended 2017-02-02)' format: date-time type: string id: description: 'Example: 30376' type: integer imageUrl: description: >- Example: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg type: string inputType: description: 'Example: value' type: string ionIcon: description: 'Example: ion-ios-medkit-outline' type: string lastValue: description: 'Example: 500' format: double type: number localDailyReminderNotificationTimes: items: type: string type: array localDailyReminderNotificationTimesForAllReminders: items: type: string type: array manualTracking: description: 'Example: true' type: boolean message: description: Message type: string minimumAllowedValue: description: 'Example: 0' type: integer nextReminderTimeEpochSeconds: description: 'Example: 1502373600' type: integer numberOfRawMeasurements: description: 'Example: 791' type: integer pngPath: description: 'Example: img/variable_categories/treatments.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.png type: string reminderFrequency: description: 'Example: 86400' type: integer reminderStartEpochSeconds: description: 'Example: 1481896800' type: integer reminderStartTime: description: 'Example: 14:00:00' format: date-time type: string reminderStartTimeLocal: description: 'Example: 09:00:00' format: date-time type: string reminderStartTimeLocalHumanFormatted: description: 'Example: 09:00 AM' format: date-time type: string repeating: description: 'Example: true' type: boolean secondDailyReminderTime: description: 'Example: 14:00:00' format: date-time type: string secondToLastValue: description: 'Example: 250' format: double type: number startTrackingDate: description: 'Example: 2016-12-16' type: string status: description: Status code type: integer stopTrackingDate: description: 'Example: 2017-02-02' type: string success: type: boolean svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.svg type: string thirdToLastValue: description: 'Example: 250' format: double type: number trackingReminderId: description: 'Example: 30376' type: integer trackingReminderImageUrl: description: >- Example: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg type: string updatedAt: description: 'Example: 2017-08-09 19:38:05' format: date-time type: string userId: description: 'Example: 230' type: integer userVariableUnitAbbreviatedName: description: 'Example: mg' type: string userVariableUnitCategoryId: description: 'Example: 3' type: integer userVariableUnitCategoryName: description: 'Example: Weight' type: string userVariableUnitId: description: 'Example: 7' type: integer userVariableUnitName: description: 'Example: Milligrams' type: string userVariableVariableCategoryId: description: 'Example: 13' type: integer userVariableVariableCategoryName: description: 'Example: Treatments' type: string valueAndFrequencyTextDescription: description: 'Example: 500 mg daily (ended 2017-02-02)' type: string valueAndFrequencyTextDescriptionWithTime: description: 'Example: 500 mg daily at 09:00 AM (ended 2017-02-02)' format: date-time type: string variableCategoryId: description: 'Example: 13' type: integer variableCategoryImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Healthcare/pill-96.png' type: string variableCategoryName: description: 'Example: Treatments' type: string variableId: description: 'Example: 5627291' type: integer variableName: description: 'Example: Acetyl L-Carnitine By MRM' type: string required: - status - success GetTrackingRemindersResponseArray: items: $ref: '#/definitions/GetTrackingRemindersResponse' type: array Highchart: properties: chartConfig: $ref: '#/definitions/ChartConfig' chartId: description: 'Example: correlationScatterPlot' type: string chartTitle: description: 'Example: Overall Mood following Sleep Duration (R = -0.173)' type: string explanation: description: >- Example: The chart above indicates that an increase in Sleep Duration is usually followed by an decrease in Overall Mood. type: string HighchartArray: items: $ref: '#/definitions/Highchart' type: array Hover: properties: enabled: description: 'Example: true' type: boolean lineColor: description: 'Example: rgb(100,100,100)' type: string marker: $ref: '#/definitions/Marker' required: - enabled - lineColor - marker Image: properties: height: description: 'Example: 240' type: string imageUrl: description: 'Example: https://www.filepicker.io/api/file/TjmeNWS5Q2SFmtJlUGLf' type: string width: description: 'Example: 224' type: string required: - height - imageUrl - width JsonErrorResponse: properties: message: description: Error message type: string status: description: 'Status: "ok" or "error"' type: string required: - status Lang: properties: loading: description: 'Example: ' type: string required: - loading Legend: properties: enabled: description: 'Example: false' type: boolean required: - enabled Loading: properties: hideDuration: description: 'Example: 10' type: integer showDuration: description: 'Example: 10' type: integer style: $ref: '#/definitions/ChartStyle' required: - hideDuration - showDuration - style LocalDailyReminderNotificationTime: properties: LocalDailyReminderNotificationTime: description: 'Example: 00:10:00' format: date-time type: string LocalDailyReminderNotificationTimeArray: items: $ref: '#/definitions/LocalDailyReminderNotificationTime' type: array LocalDailyReminderNotificationTimesForAllReminder: properties: LocalDailyReminderNotificationTimesForAllReminder: description: 'Example: 00:10:00' format: date-time type: string LocalDailyReminderNotificationTimesForAllReminderArray: items: $ref: '#/definitions/LocalDailyReminderNotificationTimesForAllReminder' type: array Marker: properties: enabled: description: 'Example: false' type: boolean radius: description: 'Example: 5' type: integer states: $ref: '#/definitions/State' required: - enabled - radius - states Measurement: properties: clientId: description: 'Example: quantimodo' type: string connectorId: description: 'Example: 13' type: integer createdAt: description: 'Example: 2017-07-30 21:08:36' type: string iconIcon: description: 'Example: ion-sad-outline' type: string id: description: 'Example: 1051466127' type: integer inputType: description: 'Example: value' type: string ionIcon: description: 'Example: ion-ios-medkit-outline' type: string manualTracking: description: 'Example: 1' type: boolean maximumAllowedValue: description: 'Example: 5' type: integer minimumAllowedValue: description: 'Example: 1' type: integer note: description: Note of measurement type: string originalunitAbbreviatedName: description: Original Unit of measurement as originally submitted type: string originalUnitAbbreviatedName: description: 'Example: count' type: string originalUnitCategoryId: description: 'Example: 6' type: integer originalUnitCategoryName: description: 'Example: Miscellany' type: string originalUnitId: description: 'Example: 23' type: integer originalUnitName: description: 'Example: Count' type: string originalValue: description: Original value as originally submitted type: integer pngPath: description: 'Example: img/variable_categories/treatments.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.png type: string sourceName: description: Application or device used to record the measurement values type: string startDate: description: 'Example: 2014-08-27' type: string startTimeEpoch: description: >- Seconds between the start of the event measured and 1970 (Unix timestamp) type: integer startTimeString: description: >- Start Time for the measurement event in UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` type: string svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.svg type: string unitAbbreviatedName: description: Abbreviated name for the unit of measurement type: string unitCategoryId: description: 'Example: 6' type: integer unitCategoryName: description: 'Example: Miscellany' type: string unitId: description: 'Example: 23' type: integer unitName: description: 'Example: Count' type: string updatedAt: description: 'Example: 2017-07-30 21:08:36' type: string userVariableUnitAbbreviatedName: description: 'Example: count' type: string userVariableUnitCategoryId: description: 'Example: 6' type: integer userVariableUnitCategoryName: description: 'Example: Miscellany' type: string userVariableUnitId: description: 'Example: 23' type: integer userVariableUnitName: description: 'Example: Count' type: string userVariableVariableCategoryId: description: 'Example: 13' type: integer userVariableVariableCategoryName: description: 'Example: Treatments' type: string valence: description: 'Example: negative' type: string value: description: Converted measurement value in requested unit format: double type: number variableCategoryId: description: 'Example: 13' type: integer variableCategoryImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Healthcare/pill-96.png' type: string variableCategoryName: description: 'Example: Treatments' type: string variableDescription: description: 'Example: negative' type: string variableId: description: 'Example: 5956846' type: integer variableName: description: Name of the variable for which we are creating the measurement records type: string required: - sourceName - startTimeString - unitAbbreviatedName - value - variableName MeasurementArray: items: $ref: '#/definitions/Measurement' type: array MeasurementDelete: properties: startTime: description: Start time of the measurement to be deleted type: integer variableId: description: Variable id of the measurement to be deleted type: integer required: - startTime - variableId MeasurementItem: properties: note: description: Optional note to include with the measurement type: string timestamp: description: Timestamp for the measurement event in epoch time (unixtime) format: int64 type: integer value: description: Measurement value format: double type: number required: - timestamp - value MeasurementSet: properties: combinationOperation: description: >- Way to aggregate measurements over time. Options are "MEAN" or "SUM". SUM should be used for things like minutes of exercise. If you use MEAN for exercise, then a person might exercise more minutes in one day but add separate measurements that were smaller. So when we are doing correlational analysis, we would think that the person exercised less that day even though they exercised more. Conversely, we must use MEAN for things such as ratings which cannot be SUMMED. enum: - MEAN - SUM type: string measurementItems: description: 'Array of timestamps, values, and optional notes' items: $ref: '#/definitions/MeasurementItem' type: array sourceName: description: >- Name of the application or device used to record the measurement values type: string unitAbbreviatedName: description: Unit of measurement type: string variableCategoryName: description: Variable category name type: string variableName: description: >- ORIGINAL name of the variable for which we are creating the measurement records type: string required: - measurementItems - sourceName - unitAbbreviatedName - variableName MeasurementUpdate: properties: id: description: Variable id of the measurement to be updated type: integer note: description: The new note for the measurement (optional) type: string startTime: description: The new timestamp for the the event in epoch seconds (optional) type: integer value: description: The new value of for the measurement (optional) format: double type: number required: - id Option: properties: chart: $ref: '#/definitions/Chart' colors: items: type: string type: array credits: $ref: '#/definitions/Credit' lang: $ref: '#/definitions/Lang' legend: $ref: '#/definitions/Legend' loading: $ref: '#/definitions/Loading' plotOptions: $ref: '#/definitions/PlotOption' title: $ref: '#/definitions/Title' xAxis: $ref: '#/definitions/XAxi' yAxis: items: $ref: '#/definitions/YAxi' type: array required: - chart - colors - credits - lang - legend - loading - plotOptions - title - xAxis - yAxis Pair: properties: causeMeasurement: description: 'Example: 101341.66666667' format: double type: number causeMeasurementValue: description: 'Example: 101341.66666667' format: double type: number causeVariableUnitAbbreviatedName: description: 'Example: mg' type: string effectMeasurement: description: 'Example: 7.98' format: double type: number effectMeasurementValue: description: 'Example: 7.98' format: double type: number effectVariableUnitAbbreviatedName: description: 'Example: %' type: string eventAt: description: 'Example: 2015-08-06 15:49:02' format: date-time type: string eventAtUnixTime: description: 'Example: 1438876142' type: integer startTimeSting: description: 'Example: 2016-06-03 07:00:00' format: date-time type: string startTimeString: description: 'Example: 2015-08-06 15:49:02' format: date-time type: string timestamp: description: 'Example: 1464937200' type: integer required: - causeMeasurement - causeMeasurementValue - causeVariableUnitAbbreviatedName - effectMeasurement - effectMeasurementValue - effectVariableUnitAbbreviatedName - startTimeSting - timestamp PairArray: items: $ref: '#/definitions/Pair' type: array Pairs: properties: name: description: Category name type: string required: - name PairsOfAveragesForAllUser: properties: causeVariableAverageValue: description: 'Example: 435.73' format: double type: number effectVariableAverageValue: description: 'Example: 3.3705' format: double type: number PairsOfAveragesForAllUserArray: items: $ref: '#/definitions/PairsOfAveragesForAllUser' type: array ParticipantInstruction: properties: instructionsForCauseVariable: description: >- Example: Obtain Fitbit and use it to record your Sleep Duration. Once you have a Fitbit account, connect your Fitbit account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffectVariable: description: >- Example: Obtain QuantiModo and use it to record your Overall Mood. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string PlotOption: properties: column: $ref: '#/definitions/Column' scatter: $ref: '#/definitions/Scatter' required: - column - scatter PostCorrelation: properties: causeVariableName: description: Cause variable name type: string correlation: description: Correlation value format: double type: number effectVariableName: description: Effect variable name type: string vote: description: 'Vote: 0 or 1' type: integer required: - causeVariableName - correlation - effectVariableName PostMeasurementsDataResponse: properties: userVariables: items: $ref: '#/definitions/UserVariable' type: array PostMeasurementsResponse: properties: data: $ref: '#/definitions/PostMeasurementsDataResponse' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success PostStudyPublishResponse: properties: status: description: 'Example: ok' type: string success: description: 'Example: true' type: boolean PostTrackingRemindersDataResponse: properties: trackingReminderNotifications: items: $ref: '#/definitions/TrackingReminderNotification' type: array trackingReminders: items: $ref: '#/definitions/TrackingReminder' type: array userVariables: items: $ref: '#/definitions/UserVariable' type: array PostTrackingRemindersResponse: properties: data: $ref: '#/definitions/PostTrackingRemindersDataResponse' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success PostUserSettingsDataResponse: properties: purchaseId: description: 'Example: 1' type: integer PostUserSettingsResponse: properties: data: $ref: '#/definitions/PostUserSettingsDataResponse' message: description: Message type: string status: description: Status code type: integer success: type: boolean required: - status - success type: object ProcessedDailyMeasurement: properties: duration: description: 'Example: 0' type: integer id: description: 'Example: ' type: string note: description: 'Example: ' type: string originalUnitId: description: 'Example: 47, 47, 47, 47, 47, 47' type: string originalValue: description: 'Example: 101800, 101800, 101700, 101600, 101600, 101600' type: string startDate: description: 'Example: 2016-06-03' type: string startTimeEpoch: description: 'Example: 1464937200' type: integer startTimeString: description: 'Example: 2016-06-03 07:00:00' format: date-time type: string unitId: description: 'Example: 47' type: integer value: description: 'Example: 101341.66666667' format: double type: number variableCategoryId: description: 'Example: 17' type: integer variableId: description: 'Example: 96380' type: integer variableName: description: 'Example: Barometric Pressure' type: string required: - duration - id - note - originalUnitId - originalValue - startDate - startTimeEpoch - startTimeString - unitId - value - variableCategoryId - variableId - variableName Scatter: properties: marker: $ref: '#/definitions/Marker' states: $ref: '#/definitions/State' tooltip: $ref: '#/definitions/Tooltip' required: - marker - states - tooltip Scope: properties: scalar: description: 'Example: user_likes' type: string ScopeArray: items: $ref: '#/definitions/Scope' type: array Series: properties: color: description: 'Example: rgba(223, 83, 83, .5)' type: string data: items: $ref: '#/definitions/Series' type: array name: description: 'Example: Reference And Learning Hours by Barometric Pressure' type: string tooltip: $ref: '#/definitions/Tooltip' type: description: 'Example: spline' type: string yAxis: description: 'Example: 1' type: integer required: - color - data - name - tooltip - type - yAxis State: properties: hover: $ref: '#/definitions/Hover' required: - hover Statistic: properties: allPairsSignificance: description: 'Example: 0.99994982531794' format: double type: number averageDailyHighCause: description: 'Example: 101627.85' format: double type: number averageDailyLowCause: description: 'Example: 21023.36' format: double type: number averageEffect: description: 'Example: 8.4268686868687' format: double type: number averageEffectFollowingHighCause: description: 'Example: 8.5' format: double type: number averageEffectFollowingHighCauseExplanation: description: >- Example: Reference And Learning Hours is 8.5h (1% higher) on average after days with around 101627.85 Pa Barometric Pressure type: string averageEffectFollowingLowCause: description: 'Example: 1.47' format: double type: number averageEffectFollowingLowCauseExplanation: description: >- Example: Reference And Learning Hours is 1.47h (83% lower) on average after days with around 21023.36 Pa Barometric Pressure type: string averageForwardPearsonCorrelationOverOnsetDelays: description: 'Example: ' type: string averagePearsonCorrelationCoefficientOverOnsetDelays: description: 'Example: ' type: string averageReversePearsonCorrelationOverOnsetDelays: description: 'Example: ' type: string averageVote: description: 'Example: ' type: string calculationStartTime: description: 'Example: ' format: date-time type: string causalityFactor: description: 'Example: 0.147' format: double type: number causeChanges: description: 'Example: 287' type: integer causeChangesStatisticalSignificance: description: 'Example: 0.9999299755903' format: double type: number causeNumberOfProcessedDailyMeasurements: description: 'Example: 1364' type: integer causeNumberOfRawMeasurements: description: 'Example: 14764' type: integer causeUserVariableShareUserMeasurements: description: 'Example: ' type: string causeValueSpread: description: 'Example: 99032.44787234' format: double type: number causeVariableCategoryId: description: 'Example: 17' type: integer causeVariableCategoryName: description: 'Example: Environment' type: string causeVariableCombinationOperation: description: 'Example: ' type: string causeVariableUnitAbbreviatedName: description: 'Example: Pa' type: string causeVariableUnitId: description: 'Example: 47' type: integer causeVariableUnitName: description: 'Example: ' type: string causeVariableId: description: 'Example: 96380' type: integer causeVariableImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Weather/chance_of_storm-96.png type: string causeVariableIonIcon: description: 'Example: ion-ios-partlysunny' type: string causeVariableMostCommonConnectorId: description: 'Example: 13' type: integer causeVariableName: description: 'Example: Barometric Pressure' type: string confidenceInterval: description: 'Example: 1.4269359716898' format: double type: number confidenceLevel: description: 'Example: high' type: string correlationCoefficient: description: 'Example: 0.147' format: double type: number correlationIsContradictoryToOptimalValues: description: 'Example: false' type: boolean correlationsOverDurationsOfAction: description: 'Example: ' type: string correlationsOverDurationsOfActionChartConfig: description: 'Example: ' type: string correlationsOverOnsetDelaysChartConfig: description: 'Example: ' type: string createdAt: description: 'Example: ' format: date-time type: string criticalTValue: description: 'Example: 1.646' format: double type: number dataAnalysis: description: >- Example: It was assumed that 0 hours would pass before a change in Barometric Pressure would produce an observable change in Reference And Learning Hours. It was assumed that Barometric Pressure could produce an observable change in Reference And Learning Hours for as much as 7 days after the stimulus event. type: string dataPoints: description: 'Example: ' type: string dataSources: description: >- Example: Barometric Pressure data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values.
Reference And Learning Hours data was primarily collected using RescueTime. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs. type: string dataSourcesParagraphForCause: description: >- Example: Barometric Pressure data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string dataSourcesParagraphForEffect: description: >- Example: Reference And Learning Hours data was primarily collected using RescueTime. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs. type: string degreesOfFreedom: description: 'Example: 200' type: integer direction: description: 'Example: higher' type: string distanceFromMiddleToBeHightLowEffect: description: 'Example: 25' type: integer durationOfAction: description: 'Example: 604800' type: integer durationOfActionInHours: description: 'Example: 0' type: integer effectChanges: description: 'Example: 295' type: integer effectNumberOfProcessedDailyMeasurements: description: 'Example: 145' type: integer effectNumberOfRawMeasurements: description: 'Example: 4045' type: integer effectSize: description: 'Example: weakly positive' type: string effectUnit: description: 'Example: h' type: string effectUserVariableShareUserMeasurements: description: 'Example: ' type: string effectValueSpread: description: 'Example: 20.2' format: double type: number effectVariableCategoryId: description: 'Example: 14' type: integer effectVariableCategoryName: description: 'Example: Activity' type: string effectVariableUnitAbbreviatedName: description: 'Example: h' type: string effectVariableUnitId: description: 'Example: 34' type: integer effectVariableUnitName: description: 'Example: ' type: string effectVariableId: description: 'Example: 111642' type: integer effectVariableImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Sports/football-96.png' type: string effectVariableIonIcon: description: 'Example: ion-ios-body-outline' type: string effectVariableMostCommonConnectorId: description: 'Example: 11' type: integer effectVariableName: description: 'Example: Reference And Learning Hours' type: string error: description: 'Example: optimalPearsonProduct is not defined' type: string experimentEndTime: description: 'Example: 1501722000' type: integer experimentStartTime: description: 'Example: 1464937200' type: integer forwardSpearmanCorrelationCoefficient: description: 'Example: -0.26193208156295' format: double type: number gaugeImage: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-weakly-positive-relationship.png type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-weakly-positive-relationship-200-200.png type: string imageUrl: description: >- Example: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-weakly-positive-relationship_environment_activity_logo_background.png type: string instructionsForCause: description: >- Example: Obtain QuantiModo and use it to record your Barometric Pressure. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffect: description: >- Example: Obtain RescueTime and use it to record your Reference And Learning Hours. Once you have a RescueTime account, connect your RescueTime account at QuantiModo to automatically import and analyze your data. type: string maximumCauseValue: description: 'Example: 104300' format: double type: number maximumEffectValue: description: 'Example: 20.38' format: double type: number medianOfLowerHalfOfEffectMeasurements: description: 'Example: ' type: string medianOfUpperHalfOfEffectMeasurements: description: 'Example: ' type: string minimumCauseValue: description: 'Example: 5267.5521276596' format: double type: number minimumEffectValue: description: 'Example: 0.18' format: double type: number minimumProbability: description: 'Example: 0.05' format: double type: number numberOfCauseChangesForOptimalValues: description: 'Example: 287' type: integer numberOfDays: description: 'Example: 425' type: integer numberOfDaysSignificance: description: 'Example: 0.99999929612614' format: double type: number numberOfEffectChangesForOptimalValues: description: 'Example: 295' type: integer numberOfHighEffectPairs: description: 'Example: 27' type: integer numberOfLowEffectPairs: description: 'Example: 57' type: integer numberOfPairs: description: 'Example: 297' type: integer numberOfSamples: description: 'Example: 297' type: integer numberOfUniqueCauseValuesForOptimalValues: description: 'Example: 201' type: integer numberOfUniqueEffectValuesForOptimalValues: description: 'Example: 264' type: integer numberOfUsers: description: 'Example: ' type: string onsetDelay: description: 'Example: 0' type: integer onsetDelayInHours: description: 'Example: 0' type: integer onsetDelayWithStrongestPearsonCorrelation: description: 'Example: ' type: string onsetDelayWithStrongestPearsonCorrelationInHours: description: 'Example: ' type: string optimalChangeSpread: description: 'Example: 83.44' format: double type: number optimalChangeSpreadSignificance: description: 'Example: 0.99999999999917' format: double type: number optimalPearsonProduct: description: 'Example: 0.063550992332336' format: double type: number outcomeDataSources: description: 'Example: ' type: string outcomeFillingValue: description: 'Example: ' type: string outcomeMaximumAllowedValue: description: 'Example: ' type: string pairsOverTimeChartConfig: description: 'Example: ' format: date-time type: string pearsonCorrelationWithNoOnsetDelay: description: 'Example: ' type: string perDaySentenceFragment: description: 'Example: ' type: string predictivePearsonCorrelation: description: 'Example: ' type: string predictivePearsonCorrelationCoefficient: description: 'Example: 0.147' format: double type: number predictorExplanation: description: >- Example: Barometric Pressure Predicts Higher Reference And Learning Hours type: string predictorFillingValue: description: 'Example: ' type: string predictorMaximumAllowedValue: description: 'Example: ' type: string predictsHighEffectChange: description: 'Example: 0.84' format: double type: number predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 0.84% ' type: string predictsLowEffectChange: description: 'Example: -82.6' format: double type: number predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 82.6% ' type: string principalInvestigator: description: 'Example: ' type: string pValue: description: 'Example: 0' format: double type: number qmScore: description: 'Example: ' type: string rawCauseMeasurementSignificance: description: 'Example: 1' format: double type: number rawEffectMeasurementSignificance: description: 'Example: 1' format: double type: number reversePairsCount: description: 'Example: ' type: string reversePearsonCorrelationCoefficient: description: 'Example: ' type: string shareUserMeasurements: description: 'Example: false' type: boolean significanceExplanation: description: >- Example: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Reference And Learning Hours is statistically significant at 95% confidence interval. type: string significantDifference: description: 'Example: true' type: boolean statisticalSignificance: description: 'Example: 0.99987910063243' format: double type: number strengthLevel: description: 'Example: very weak' type: string strongestPearsonCorrelationCoefficient: description: 'Example: ' type: string studyAbstract: description: >- Example: Your data suggests with a high degree of confidence (p=0) that Barometric Pressure (Environment) has a weakly positive predictive relationship (R=0.147) with Reference And Learning Hours (Activity). The highest quartile of Reference And Learning Hours measurements were observed following an average 101187.2Pa Barometric Pressure. The lowest quartile of Reference And Learning Hours measurements were observed following an average 97597.75Pa Barometric Pressure. type: string studyBackground: description: 'Example: ' type: string studyDesign: description: >- Example: This study is based on data donated by one QuantiModo user. Thus, the study design is consistent with an n=1 observational natural experiment. type: string studyLimitations: description: >- Example: As with any human experiment, it was impossible to control for all potentially confounding variables. Correlation does not necessarily imply correlation. We can never know for sure if one factor is definitely the cause of an outcome. However, lack of correlation definitely implies the lack of a causal relationship. Hence, we can with great confidence rule out non-existent relationships. For instance, if we discover no relationship between mood and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship.

We can also take advantage of several characteristics of time series data from many subjects to infer the likelihood of a causal relationship if we do find a correlational relationship. The criteria for causation are a group of minimal conditions necessary to provide adequate evidence of a causal relationship between an incidence and a possible consequence. The list of the criteria is as follows:
1. Strength (effect size): A small association does not mean that there is not a causal effect, though the larger the association, the more likely that it is causal.
2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect.
3. Specificity: Causation is likely if a very specific population at a specific site and disease with no other likely explanation. The more specific an association between a factor and an effect is, the bigger the probability of a causal relationship.
4. Temporality: The effect has to occur after the cause (and if there is an expected delay between the cause and expected effect, then the effect must occur after that delay).
5. Biological gradient: Greater exposure should generally lead to greater incidence of the effect. However, in some cases, the mere presence of the factor can trigger the effect. In other cases, an inverse proportion is observed: greater exposure leads to lower incidence.
6. Plausibility: A plausible mechanism between cause and effect is helpful.
7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect.
8. Experiment: "Occasionally it is possible to appeal to experimental evidence".
9. Analogy: The effect of similar factors may be considered.

The confidence in a causal relationship is bolstered by the fact that time-precedence was taken into account in all calculations. Furthermore, in accordance with the law of large numbers (LLN), the predictive power and accuracy of these results will continually grow over time. 297 paired data points were used in this analysis. Assuming that the relationship is merely coincidental, as the participant independently modifies their Barometric Pressure values, the observed strength of the relationship will decline until it is below the threshold of significance. To it another way, in the case that we do find a spurious correlation, suggesting that banana intake improves mood for instance, one will likely increase their banana intake. Due to the fact that this correlation is spurious, it is unlikely that you will see a continued and persistent corresponding increase in mood. So over time, the spurious correlation will naturally dissipate.Furthermore, it will be very enlightening to aggregate this data with the data from other participants with similar genetic, diseasomic, environmentomic, and demographic profiles. type: string studyLinkDynamic: description: >- Example: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Barometric%20Pressure&effectVariableName=Reference%20And%20Learning%20Hours&userId=230 type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Barometric%20Pressure%20Predicts%20Higher%20Reference%20And%20Learning%20Hours&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DBarometric%2520Pressure%26effectVariableName%3DReference%2520And%2520Learning%2520Hours%26userId%3D230%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: >- Example: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DBarometric%2520Pressure%26effectVariableName%3DReference%2520And%2520Learning%2520Hours%26userId%3D230 type: string studyLinkGoogle: description: >- Example: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DBarometric%2520Pressure%26effectVariableName%3DReference%2520And%2520Learning%2520Hours%26userId%3D230 type: string studyLinkStatic: description: >- Example: https://local.quantimo.do/api/v2/study?causeVariableName=Barometric%20Pressure&effectVariableName=Reference%20And%20Learning%20Hours&userId=230 type: string studyLinkTwitter: description: >- Example: https://twitter.com/home?status=Barometric%20Pressure%20Predicts%20Higher%20Reference%20And%20Learning%20Hours%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DBarometric%2520Pressure%26effectVariableName%3DReference%2520And%2520Learning%2520Hours%26userId%3D230%20%40quantimodo type: string studyObjective: description: >- Example: The objective of this study is to determine the nature of the relationship (if any) between the Barometric Pressure and the Reference And Learning Hours. Additionally, we attempt to determine the Barometric Pressure values most likely to produce optimal Reference And Learning Hours values. type: string studyResults: description: >- Example: This analysis suggests that higher Barometric Pressure (Environment) generally predicts higher Reference And Learning Hours (p = 0). Reference And Learning Hours is, on average, 0.84% higher after around 101187.2 Barometric Pressure. After an onset delay of 168 hours, Reference And Learning Hours is, on average, 82.6% lower than its average over the 168 hours following around 97597.75 Barometric Pressure. 297 data points were used in this analysis. The value for Barometric Pressure changed 287 times, effectively running 144 separate natural experiments. The top quartile outcome values are preceded by an average 101187.2 Pa of Barometric Pressure. The bottom quartile outcome values are preceded by an average 97597.75 Pa of Barometric Pressure. Forward Pearson Correlation Coefficient was 0.147 (p=0, 95% CI -1.28 to 1.574 onset delay = 0 hours, duration of action = 168 hours) . The Reverse Pearson Correlation Coefficient was 0 (P=0, 95% CI -1.427 to 1.427, onset delay = -0 hours, duration of action = -168 hours). When the Barometric Pressure value is closer to 101187.2 Pa than 97597.75 Pa, the Reference And Learning Hours value which follows is, on average, 0.84% percent higher than its typical value. When the Barometric Pressure value is closer to 97597.75 Pa than 101187.2 Pa, the Reference And Learning Hours value which follows is 0% lower than its typical value. Reference And Learning Hours is 8.5h (1% higher) on average after days with around 101627.85 Pa Barometric Pressure Reference And Learning Hours is 1.47h (83% lower) on average after days with around 21023.36 Pa Barometric Pressure type: string studyTitle: description: >- Example: N1 Study: Barometric Pressure Predicts Higher Reference And Learning Hours type: string timestamp: description: 'Example: 1502080560' type: integer tValue: description: 'Example: 8.1106621038493' format: double type: number updatedAt: description: 'Example: ' format: date-time type: string userId: description: 'Example: 230' type: integer userVote: description: 'Example: ' type: string valuePredictingHighOutcome: description: 'Example: 101187.2' format: double type: number valuePredictingHighOutcomeExplanation: description: >- Example: Reference And Learning Hours, on average, 0.84% higher after around 101187.2 Pa Barometric Pressure type: string valuePredictingLowOutcome: description: 'Example: 97597.75' format: double type: number valuePredictingLowOutcomeExplanation: description: >- Example: Reference And Learning Hours, on average, 82.6% lower after around 97597.75 Pa Barometric Pressure type: string voteStatisticalSignificance: description: 'Example: 1' type: integer required: - allPairsSignificance - averageDailyHighCause - averageDailyLowCause - averageEffect - averageEffectFollowingHighCause - averageEffectFollowingHighCauseExplanation - averageEffectFollowingLowCause - averageEffectFollowingLowCauseExplanation - averageForwardPearsonCorrelationOverOnsetDelays - averagePearsonCorrelationCoefficientOverOnsetDelays - averageReversePearsonCorrelationOverOnsetDelays - averageVote - calculationStartTime - causalityFactor - causeChanges - causeChangesStatisticalSignificance - causeNumberOfProcessedDailyMeasurements - causeNumberOfRawMeasurements - causeUserVariableShareUserMeasurements - causeValueSpread - causeVariableCategoryId - causeVariableCategoryName - causeVariableCombinationOperation - causeVariableUnitAbbreviatedName - causeVariableUnitId - causeVariableUnitName - causeVariableId - causeVariableImageUrl - causeVariableIonIcon - causeVariableMostCommonConnectorId - causeVariableName - confidenceInterval - confidenceLevel - correlationCoefficient - correlationIsContradictoryToOptimalValues - correlationsOverDurationsOfAction - correlationsOverDurationsOfActionChartConfig - correlationsOverOnsetDelaysChartConfig - createdAt - criticalTValue - dataAnalysis - dataPoints - dataSources - dataSourcesParagraphForCause - dataSourcesParagraphForEffect - degreesOfFreedom - direction - distanceFromMiddleToBeHightLowEffect - durationOfAction - durationOfActionInHours - effectChanges - effectNumberOfProcessedDailyMeasurements - effectNumberOfRawMeasurements - effectSize - effectUnit - effectUserVariableShareUserMeasurements - effectValueSpread - effectVariableCategoryId - effectVariableCategoryName - effectVariableUnitAbbreviatedName - effectVariableUnitId - effectVariableUnitName - effectVariableId - effectVariableImageUrl - effectVariableIonIcon - effectVariableMostCommonConnectorId - effectVariableName - error - experimentEndTime - experimentStartTime - forwardSpearmanCorrelationCoefficient - gaugeImage - gaugeImageSquare - imageUrl - instructionsForCause - instructionsForEffect - maximumCauseValue - maximumEffectValue - medianOfLowerHalfOfEffectMeasurements - medianOfUpperHalfOfEffectMeasurements - minimumCauseValue - minimumEffectValue - minimumProbability - numberOfCauseChangesForOptimalValues - numberOfDays - numberOfDaysSignificance - numberOfEffectChangesForOptimalValues - numberOfHighEffectPairs - numberOfLowEffectPairs - numberOfPairs - numberOfSamples - numberOfUniqueCauseValuesForOptimalValues - numberOfUniqueEffectValuesForOptimalValues - numberOfUsers - onsetDelay - onsetDelayInHours - onsetDelayWithStrongestPearsonCorrelation - onsetDelayWithStrongestPearsonCorrelationInHours - optimalChangeSpread - optimalChangeSpreadSignificance - optimalPearsonProduct - outcomeDataSources - outcomeFillingValue - outcomeMaximumAllowedValue - pValue - pairsOverTimeChartConfig - pearsonCorrelationWithNoOnsetDelay - perDaySentenceFragment - predictivePearsonCorrelation - predictivePearsonCorrelationCoefficient - predictorExplanation - predictorFillingValue - predictorMaximumAllowedValue - predictsHighEffectChange - predictsHighEffectChangeSentenceFragment - predictsLowEffectChange - predictsLowEffectChangeSentenceFragment - principalInvestigator - qmScore - rawCauseMeasurementSignificance - rawEffectMeasurementSignificance - reversePairsCount - reversePearsonCorrelationCoefficient - shareUserMeasurements - significanceExplanation - significantDifference - statisticalSignificance - strengthLevel - strongestPearsonCorrelationCoefficient - studyAbstract - studyBackground - studyDesign - studyLimitations - studyLinkDynamic - studyLinkEmail - studyLinkFacebook - studyLinkGoogle - studyLinkStatic - studyLinkTwitter - studyObjective - studyResults - studyTitle - tValue - timestamp - updatedAt - userId - userVote - valuePredictingHighOutcome - valuePredictingHighOutcomeExplanation - valuePredictingLowOutcome - valuePredictingLowOutcomeExplanation - voteStatisticalSignificance Study: properties: causeProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array causeVariable: $ref: '#/definitions/UserVariable' charts: items: $ref: '#/definitions/Highchart' type: array effectProcessedDailyMeasurements: items: $ref: '#/definitions/ProcessedDailyMeasurement' type: array effectVariable: $ref: '#/definitions/UserVariable' highcharts: $ref: '#/definitions/HighchartArray' pairs: items: $ref: '#/definitions/Pair' type: array statistics: $ref: '#/definitions/Statistic' text: description: 'Example: ' type: string user: description: 'Example: ' type: string userId: description: 'Example: 230' type: integer required: - causeProcessedDailyMeasurements - causeVariable - charts - effectProcessedDailyMeasurements - effectVariable - pairs - statistics - text - user Subtitle: properties: text: description: 'Example: ' type: string required: - text Text: properties: dataAnalysis: description: >- Example: It was assumed that 0 hours would pass before a change in Very Distracting Time would produce an observable change in Video Activities. It was assumed that Very Distracting Time could produce an observable change in Video Activities for as much as 7 days after the stimulus event. type: string dataSources: description: >- Example: Very Distracting Time data was primarily collected using RescueTime. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs.
Video Activities data was primarily collected using RescueTime. Detailed reports show which applications and websites you spent time on. Activities are automatically grouped into pre-defined categories with built-in productivity scores covering thousands of websites and applications. You can customize categories and productivity scores to meet your needs. type: string significanceExplanation: description: >- Example: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Video Activities is statistically significant at 95% confidence interval. type: string studyAbstract: description: >- Example: Aggregated data from 21 suggests with a low degree of confidence (p=0.097) that Very Distracting Time (Work) has a moderately positive predictive relationship (R=0.354) with Video Activities (Activity). The highest quartile of Video Activities measurements were observed following an average 2.03h Very Distracting Timeper day. The lowest quartile of Video Activities measurements were observed following an average 1.04h Very Distracting Timeper day. type: string studyDesign: description: >- Example: This study is based on data donated by 21 QuantiModo users. Thus, the study design is equivalent to the aggregation of 21 separate n=1 observational natural experiments. type: string studyLimitations: description: >- Example: As with any human experiment, it was impossible to control for all potentially confounding variables. Correlation does not necessarily imply correlation. We can never know for sure if one factor is definitely the cause of an outcome. However, lack of correlation definitely implies the lack of a causal relationship. Hence, we can with great confidence rule out non-existent relationships. For instance, if we discover no relationship between mood and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship.

We can also take advantage of several characteristics of time series data from many subjects to infer the likelihood of a causal relationship if we do find a correlational relationship. The criteria for causation are a group of minimal conditions necessary to provide adequate evidence of a causal relationship between an incidence and a possible consequence. The list of the criteria is as follows:
1. Strength (effect size): A small association does not mean that there is not a causal effect, though the larger the association, the more likely that it is causal.
2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect.
3. Specificity: Causation is likely if a very specific population at a specific site and disease with no other likely explanation. The more specific an association between a factor and an effect is, the bigger the probability of a causal relationship.
4. Temporality: The effect has to occur after the cause (and if there is an expected delay between the cause and expected effect, then the effect must occur after that delay).
5. Biological gradient: Greater exposure should generally lead to greater incidence of the effect. However, in some cases, the mere presence of the factor can trigger the effect. In other cases, an inverse proportion is observed: greater exposure leads to lower incidence.
6. Plausibility: A plausible mechanism between cause and effect is helpful.
7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect.
8. Experiment: "Occasionally it is possible to appeal to experimental evidence".
9. Analogy: The effect of similar factors may be considered.

The confidence in a causal relationship is bolstered by the fact that time-precedence was taken into account in all calculations. Furthermore, in accordance with the law of large numbers (LLN), the predictive power and accuracy of these results will continually grow over time. 146 paired data points were used in this analysis. Assuming that the relationship is merely coincidental, as the participant independently modifies their Very Distracting Time values, the observed strength of the relationship will decline until it is below the threshold of significance. To it another way, in the case that we do find a spurious correlation, suggesting that banana intake improves mood for instance, one will likely increase their banana intake. Due to the fact that this correlation is spurious, it is unlikely that you will see a continued and persistent corresponding increase in mood. So over time, the spurious correlation will naturally dissipate.Furthermore, it will be very enlightening to aggregate this data with the data from other participants with similar genetic, diseasomic, environmentomic, and demographic profiles. type: string studyObjective: description: >- Example: The objective of this study is to determine the nature of the relationship (if any) between the Very Distracting Time and the Video Activities. Additionally, we attempt to determine the Very Distracting Time values most likely to produce optimal Video Activities values. type: string studyResults: description: >- Example: This analysis suggests that higher Very Distracting Time (Work) generally predicts negative Video Activities (p = 0.097). Video Activities is, on average, 36% higher after around 2.03 Very Distracting Time. After an onset delay of 168 hours, Video Activities is, on average, 16% lower than its average over the 168 hours following around 1.04 Very Distracting Time. 146 data points were used in this analysis. The value for Very Distracting Time changed 2984 times, effectively running 1492 separate natural experiments. The top quartile outcome values are preceded by an average 2.03 h of Very Distracting Time. The bottom quartile outcome values are preceded by an average 1.04 h of Very Distracting Time. Forward Pearson Correlation Coefficient was 0.354 (p=0.097, 95% CI -0.437 to 1.144 onset delay = 0 hours, duration of action = 168 hours) . The Reverse Pearson Correlation Coefficient was 0.208 (P=0.097, 95% CI -0.583 to 0.998, onset delay = -0 hours, duration of action = -168 hours). When the Very Distracting Time value is closer to 2.03 h than 1.04 h, the Video Activities value which follows is, on average, 36% percent higher than its typical value. When the Very Distracting Time value is closer to 1.04 h than 2.03 h, the Video Activities value which follows is 0% lower than its typical value. Video Activities is 5 h (67% higher) on average after days with around 5 h Very Distracting Time type: string studyTitle: description: >- Example: N1 Study: Very Distracting Time Predicts Negative Video Activities type: string Title: properties: enabled: description: 'Example: true' type: boolean text: description: 'Example: Barometric Pressure (Pa)' type: string required: - enabled - text Tooltip: properties: pointFormat: description: 'Example: {point.x}Pa, {point.y}h' type: string valueSuffix: description: 'Example: Pa' type: string required: - pointFormat - valueSuffix TrackingReminder: properties: availableUnits: items: $ref: '#/definitions/Unit' type: array clientId: description: clientId type: string combinationOperation: description: The way multiple measurements are aggregated over time enum: - MEAN - SUM type: string createdAt: description: 'Example: 2016-05-18 02:24:08' format: date-time type: string unitAbbreviatedName: description: 'Example: /5' type: string unitCategoryId: description: 'Example: 5' type: integer unitCategoryName: description: 'Example: Rating' type: string unitId: description: 'Example: 10' type: integer unitName: description: 'Example: 1 to 5 Rating' type: string defaultValue: description: Default value to use for the measurement when tracking format: float type: number email: description: True if the reminders should be delivered via email type: boolean errorMessage: description: >- Example: reminderStartTimeLocal is less than $user->earliestReminderTime or greater than $user->latestReminderTime type: string fillingValue: description: 'Example: 0' type: integer firstDailyReminderTime: description: 'Example: 02:45:20' format: date-time type: string frequencyTextDescription: description: 'Example: Daily' type: string frequencyTextDescriptionWithTime: description: 'Example: Daily at 09:45 PM' type: string id: description: id format: int32 type: integer inputType: description: 'Example: saddestFaceIsFive' type: string instructions: description: 'Example: I am an instruction!' type: string ionIcon: description: 'Example: ion-sad-outline' type: string lastTracked: description: >- UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` timestamp for the last time a measurement was received for this user and variable format: date-time type: string lastValue: description: 'Example: 2' format: double type: number latestTrackingReminderNotificationReminderTime: description: >- UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` timestamp for the reminder time of the latest tracking reminder notification that has been pre-emptively generated in the database format: date-time type: string localDailyReminderNotificationTimes: items: type: string type: array localDailyReminderNotificationTimesForAllReminders: items: type: string type: array manualTracking: description: 'Example: 1' type: boolean maximumAllowedValue: description: 'Example: 5' type: integer minimumAllowedValue: description: 'Example: 1' type: integer nextReminderTimeEpochSeconds: description: 'Example: 1501555520' type: integer notificationBar: description: True if the reminders should appear in the notification bar type: boolean numberOfRawMeasurements: description: 'Example: 445' type: integer numberOfUniqueValues: description: 'Example: 1' type: integer pngPath: description: 'Example: img/variable_categories/symptoms.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/symptoms.png type: string popUp: description: True if the reminders should appear as a popup notification type: boolean reminderEndTime: description: >- Latest time of day at which reminders should appear in UTC HH:MM:SS format type: string reminderFrequency: description: Number of seconds between one reminder and the next format: int32 type: integer reminderSound: description: String identifier for the sound to accompany the reminder type: string reminderStartEpochSeconds: description: 'Example: 1469760320' type: integer reminderStartTime: description: >- Earliest time of day at which reminders should appear in UTC HH:MM:SS format type: string reminderStartTimeLocal: description: 'Example: 21:45:20' format: date-time type: string reminderStartTimeLocalHumanFormatted: description: 'Example: 09:45 PM' format: date-time type: string repeating: description: 'Example: true' type: boolean secondDailyReminderTime: description: 'Example: 01:00:00' format: date-time type: string secondToLastValue: description: 'Example: 1' format: double type: number sms: description: True if the reminders should be delivered via SMS type: boolean startTrackingDate: description: >- Earliest date on which the user should be reminded to track in YYYY-MM-DD format format: string type: string stopTrackingDate: description: >- Latest date on which the user should be reminded to track in YYYY-MM-DD format format: string type: string svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/symptoms.svg type: string thirdDailyReminderTime: description: 'Example: 20:00:00' format: date-time type: string thirdToLastValue: description: 'Example: 3' format: double type: number trackingReminderId: description: 'Example: 11841' type: integer trackingReminderImageUrl: description: 'Example: Not Found' type: string updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. format: date-time type: string userId: description: ID of User format: int32 type: integer userVariableUnitAbbreviatedName: description: 'Example: /5' type: string userVariableUnitCategoryId: description: 'Example: 5' type: integer userVariableUnitCategoryName: description: 'Example: Rating' type: string userVariableUnitId: description: 'Example: 10' type: integer userVariableUnitName: description: 'Example: 1 to 5 Rating' type: string userVariableVariableCategoryId: description: 'Example: 10' type: integer userVariableVariableCategoryName: description: 'Example: Symptoms' type: string valence: description: 'Example: negative' type: string valueAndFrequencyTextDescription: description: 'Example: Rate daily' type: string valueAndFrequencyTextDescriptionWithTime: description: 'Example: Rate daily at 09:45 PM' type: string variableCategoryId: description: 'Example: 10' type: integer variableCategoryImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Messaging/sad-96.png' type: string variableCategoryName: description: Name of the variable category to be used when sending measurements type: string variableDescription: description: 'Example: negative' type: string variableId: description: Id for the variable to be tracked format: int32 type: integer variableName: description: Name of the variable to be used when sending measurements type: string required: - reminderFrequency - unitAbbreviatedName - variableCategoryName - variableName TrackingReminderArray: items: $ref: '#/definitions/TrackingReminder' type: array TrackingReminderDelete: properties: id: description: Id of the TrackingReminder to be deleted type: integer required: - id TrackingReminderNotification: properties: actionArray: items: $ref: '#/definitions/TrackingReminderNotificationActionArray' type: array availableUnits: items: $ref: '#/definitions/Unit' type: array clientId: description: clientId type: string combinationOperation: description: The way multiple measurements are aggregated over time enum: - MEAN - SUM type: string createdAt: description: 'Example: 2017-07-29 20:49:54' format: date-time type: string unitAbbreviatedName: description: 'Example: /5' type: string unitCategoryId: description: 'Example: 5' type: integer unitCategoryName: description: 'Example: Rating' type: string unitId: description: 'Example: 10' type: integer unitName: description: 'Example: 1 to 5 Rating' type: string defaultValue: description: Default value to use for the measurement when tracking format: float type: number description: description: 'Example: positive' type: string email: description: True if the reminders should be delivered via email type: boolean fillingValue: description: 'Example: 0' type: integer iconIcon: description: 'Example: ion-sad-outline' type: string id: description: id for the specific PENDING tracking remidner format: int32 type: integer imageUrl: description: >- Example: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg type: string inputType: description: 'Example: happiestFaceIsFive' type: string ionIcon: description: 'Example: ion-happy-outline' type: string lastValue: description: 'Example: 3' format: double type: number manualTracking: description: 'Example: 1' type: boolean maximumAllowedValue: description: 'Example: 5' type: integer minimumAllowedValue: description: 'Example: 1' type: integer mostCommonValue: description: 'Example: 3' format: double type: number notificationBar: description: True if the reminders should appear in the notification bar type: boolean notifiedAt: description: 'Example: ' format: date-time type: string numberOfUniqueValues: description: 'Example: 5' type: integer pngPath: description: 'Example: img/variable_categories/emotions.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.png type: string popUp: description: True if the reminders should appear as a popup notification type: boolean reminderEndTime: description: 'Example: ' format: date-time type: string reminderFrequency: description: 'How often user should be reminded in seconds. Example: 86400' type: integer reminderSound: description: String identifier for the sound to accompany the reminder type: string reminderStartTime: description: >- Earliest time of day at which reminders should appear in UTC HH:MM:SS format type: string reminderTime: description: >- UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` timestamp for the specific time the variable should be tracked in UTC. This will be used for the measurement startTime if the track endpoint is used. format: date-time type: string secondMostCommonValue: description: 'Example: 4' format: double type: number secondToLastValue: description: 'Example: 1' format: double type: number sms: description: True if the reminders should be delivered via SMS type: boolean svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.svg type: string thirdMostCommonValue: description: 'Example: 2' format: double type: number thirdToLastValue: description: 'Example: 2' format: double type: number title: description: 'Example: Rate Overall Mood' type: string total: description: 'Example: 3' format: double type: number trackAllActions: items: $ref: '#/definitions/TrackingReminderNotificationTrackAllAction' type: array trackingReminderId: description: id for the repeating tracking remidner format: int32 type: integer trackingReminderImageUrl: description: >- Example: https://rximage.nlm.nih.gov/image/images/gallery/original/55111-0129-60_RXNAVIMAGE10_B051D81E.jpg type: string trackingReminderNotificationId: description: 'Example: 5072482' type: integer trackingReminderNotificationTime: description: >- UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` timestamp for the specific time the variable should be tracked in UTC. This will be used for the measurement startTime if the track endpoint is used. format: date-time type: string trackingReminderNotificationTimeEpoch: description: 'Example: 1501534124' type: integer trackingReminderNotificationTimeLocal: description: 'Example: 15:48:44' type: string updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. format: date-time type: string userId: description: ID of User format: int32 type: integer userVariableUnitAbbreviatedName: description: 'Example: /5' type: string userVariableUnitCategoryId: description: 'Example: 5' type: integer userVariableUnitCategoryName: description: 'Example: Rating' type: string userVariableUnitId: description: 'Example: 10' type: integer userVariableUnitName: description: 'Example: 1 to 5 Rating' type: string userVariableVariableCategoryId: description: 'Example: 1' type: integer userVariableVariableCategoryName: description: 'Example: Emotions' type: string valence: description: 'Example: positive' type: string variableCategoryId: description: 'Example: 1' type: integer variableCategoryImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string variableCategoryName: description: Name of the variable category to be used when sending measurements type: string variableId: description: Id for the variable to be tracked format: int32 type: integer variableImageUrl: description: 'Example: ' type: string variableName: description: Name of the variable to be used when sending measurements type: string required: - actionArray - availableUnits - fillingValue - id - trackAllActions TrackingReminderNotificationActionArray: properties: action: description: 'Example: track' type: string callback: description: 'Example: trackThreeRatingAction' type: string modifiedValue: description: 'Example: 3' type: integer title: description: 'Example: Rate 3/5' type: string required: - action - callback - modifiedValue - title TrackingReminderNotificationArray: items: $ref: '#/definitions/TrackingReminderNotification' type: array TrackingReminderNotificationPost: properties: action: description: >- track records a measurement for the notification. snooze changes the notification to 1 hour from now. skip deletes the notification. enum: - skip - snooze - track type: string id: description: Id of the TrackingReminderNotification type: number modifiedValue: description: >- Optional value to be recorded instead of the tracking reminder default value type: number required: - action - id TrackingReminderNotificationsArray: items: $ref: '#/definitions/TrackingReminderNotification' type: array TrackingReminderNotificationTrackAllAction: properties: action: description: 'Example: trackAll' type: string callback: description: 'Example: trackThreeRatingAction' type: string modifiedValue: description: 'Example: 3' type: integer title: description: 'Example: Rate 3/5 for all' type: string required: - action - callback - modifiedValue - title TrackingRemindersArray: items: $ref: '#/definitions/TrackingReminder' type: array Unit: properties: abbreviatedName: description: Unit abbreviation type: string advanced: description: 'Example: 1' type: integer category: description: Unit category enum: - Distance - Duration - Energy - Frequency - Miscellany - Pressure - Proportion - Rating - Temperature - Volume - Weight type: string categoryId: description: 'Example: 6' type: integer categoryName: description: 'Example: Miscellany' type: string conversionSteps: description: Conversion steps list items: $ref: '#/definitions/ConversionStep' type: array id: description: 'Example: 29' type: integer manualTracking: description: 'Example: 0' type: integer maximumAllowedValue: description: >- The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. format: double type: number maximumValue: description: 'Example: 4' type: integer minimumAllowedValue: description: >- The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. format: double type: number minimumValue: description: 'Example: 0' type: integer name: description: Unit name type: string unitCategory: $ref: '#/definitions/UnitCategory' required: - abbreviatedName - category - conversionSteps - maximumValue - name - unitCategory UnitArray: items: $ref: '#/definitions/Unit' type: array UnitCategory: properties: id: description: id type: integer name: description: Category name type: string standardUnitAbbreviatedName: description: Base unit for in which measurements are to be converted to and stored type: string required: - name User: properties: accessToken: description: User access token type: string accessTokenExpires: description: 'Example: 2018-08-08 02:41:19' type: string accessTokenExpiresAtMilliseconds: description: 'Example: 1533696079000' type: integer administrator: description: Is user administrator type: boolean avatar: description: >- Example: https://lh6.googleusercontent.com/-BHr4hyUWqZU/AAAAAAAAAAI/AAAAAAAIG28/2Lv0en738II/photo.jpg?sz=50 type: string avatarImage: description: >- Example: https://lh6.googleusercontent.com/-BHr4hyUWqZU/AAAAAAAAAAI/AAAAAAAIG28/2Lv0en738II/photo.jpg?sz=50 type: string capabilities: description: 'Example: a:1:{s:13:"administrator";b:1;}' type: string clientId: description: 'Example: quantimodo' type: string clientUserId: description: 'Example: 118444693184829555362' type: string combineNotifications: description: 'Example: 1' type: boolean displayName: description: User display name type: string earliestReminderTime: description: 'Earliest time user should get notifications. Example: 05:00:00' format: date-time type: string email: description: User email type: string firstName: description: 'Example: Mike' type: string getPreviewBuilds: description: 'Example: false' type: boolean hasAndroidApp: description: 'Example: false' type: boolean hasChromeExtension: description: 'Example: false' type: boolean hasIosApp: description: 'Example: false' type: boolean id: description: User id type: integer lastFour: description: 'Example: 2009' type: string lastName: description: 'Example: Sinn' type: string lastSmsTrackingReminderNotificationId: description: 'Example: ' type: string latestReminderTime: description: 'Latest time user should get notifications. Example: 23:00:00' type: string loginName: description: User login name type: string password: description: 'Example: PASSWORD' type: string phoneNumber: description: 'Example: ' type: string phoneVerificationCode: description: 'Example: ' type: string pushNotificationsEnabled: description: 'Example: 1' type: boolean refreshToken: description: 'Example: 6e99b113d85586de1f92468433f2df1e666647cb' type: string roles: description: 'Example: ["admin"]' type: string sendPredictorEmails: description: 'Example: 1' type: boolean sendReminderNotificationEmails: description: 'Example: 1' type: boolean smsNotificationsEnabled: description: 'Example: false' type: boolean stripeActive: description: 'Example: 1' type: boolean stripeId: description: 'Example: cus_A8CEmcvl8jwLhV' type: string stripePlan: description: 'Example: monthly7' type: string stripeSubscription: description: 'Example: sub_ANTx3nOE7nzjQf' type: string subscriptionEndsAt: description: 'Example: ' format: date-time type: string subscriptionProvider: description: 'Example: google' type: string timeZoneOffset: description: 'Example: 300' type: integer trackLocation: description: 'Example: 1' type: boolean userRegistered: description: 'Example: 2013-12-03 15:25:13' format: date-time type: string userUrl: description: 'Example: https://plus.google.com/+MikeSinn' type: string required: - accessToken - administrator - displayName - email - id - loginName UserCorrelation: properties: averageDailyHighCause: description: '' type: number averageDailyLowCause: description: '' type: number averageEffect: description: '' type: number averageEffectFollowingHighCause: description: '' type: number averageEffectFollowingHighCauseExplanation: description: '' type: string averageEffectFollowingLowCause: description: '' type: number averageEffectFollowingLowCauseExplanation: description: '' type: string averageForwardPearsonCorrelationOverOnsetDelays: description: 'Example: 0.396' format: double type: number averageReversePearsonCorrelationOverOnsetDelays: description: 'Example: 0.453667' format: double type: number averageVote: description: Average Vote type: number causalityFactor: description: '' type: number cause: description: >- Variable name of the cause variable for which the user desires correlations. type: string causeChanges: description: >- Number of changes in the predictor variable (a.k.a the number of experiments) type: integer causeUnit: description: Unit of the predictor variable type: string causeUserVariableShareUserMeasurements: description: 'Example: 1' type: integer causeVariableCategoryId: description: 'Example: 6' type: integer causeVariableCategoryName: description: Variable category of the cause variable. type: string causeVariableCombinationOperation: description: The way cause measurements are aggregated type: string causeVariableUnitAbbreviatedName: description: 'Example: /5' type: string causeVariableUnitId: description: Unit Id of the predictor variable type: integer causeVariableUnitName: description: 'Example: 1 to 5 Rating' type: string causeVariableId: description: '' type: integer causeVariableImageUrl: description: '' type: string causeVariableIonIcon: description: For use in Ionic apps type: string causeVariableMostCommonConnectorId: description: 'Example: 6' type: integer causeVariableName: description: >- Variable name of the cause variable for which the user desires correlations. type: string confidenceInterval: description: 'Example: 0.14344467795996' format: double type: number confidenceLevel: description: 'Example: high' type: string correlationCoefficient: description: Pearson correlation coefficient between cause and effect measurements type: number createdAt: description: >- When the record was first created. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string createdTime: description: 'Example: 2016-12-28 20:47:30' format: date-time type: string criticalTValue: description: 'Example: 1.646' format: double type: number dataAnalysis: description: How the data was analyzed type: string dataSources: description: How the data was obtained type: string dataSourcesParagraphForCause: description: >- Example: Sleep Quality data was primarily collected using Up by Jawbone. UP by Jawbone is a wristband and app that tracks how you sleep, move and eat and then helps you use that information to feel your best. type: string dataSourcesParagraphForEffect: description: >- Example: Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string direction: description: 'Example: higher' type: string durationOfAction: description: >- The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. type: number durationOfActionInHours: description: 'Example: 168' type: integer effect: description: >- Variable name of the effect variable for which the user desires correlations. type: string effectChanges: description: 'Example: 193' type: integer effectSize: description: >- Magnitude of the effects of a cause indicating whether it's practically meaningful. type: string effectUnit: description: 'Example: /5' type: string effectUserVariableShareUserMeasurements: description: 'Example: 1' type: integer effectVariableCategoryId: description: 'Example: 1' type: integer effectVariableCategoryName: description: Variable category of the effect variable. type: string effectVariableCombinationOperation: description: 'Example: MEAN' type: string effectVariableCommonAlias: description: 'Example: Mood_(psychology)' type: string effectVariableUnitAbbreviatedName: description: 'Example: /5' type: string effectVariableUnitId: description: 'Example: 10' type: integer effectVariableUnitName: description: 'Example: 1 to 5 Rating' type: string effectVariableId: description: >- Magnitude of the effects of a cause indicating whether it's practically meaningful. type: string effectVariableImageUrl: description: '' type: string effectVariableIonIcon: description: For use in Ionic apps type: string effectVariableMostCommonConnectorId: description: 'Example: 10' type: integer effectVariableName: description: >- Variable name of the effect variable for which the user desires correlations. type: string experimentEndTime: description: 'Example: 2014-07-30 12:50:00' format: date-time type: string experimentStartTime: description: 'Example: 2012-05-06 21:15:00' format: date-time type: string forwardSpearmanCorrelationCoefficient: description: 'Example: 0.528359' format: double type: number gaugeImage: description: Illustrates the strength of the relationship type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-moderately-positive-relationship-200-200.png type: string imageUrl: description: Large image for Facebook type: string instructionsForCause: description: >- Example: Obtain Up by Jawbone and use it to record your Sleep Quality. Once you have a Up by Jawbone account, connect your Up by Jawbone account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffect: description: >- Example: Obtain QuantiModo and use it to record your Overall Mood. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string numberOfPairs: description: Number of points that went into the correlation calculation type: number onsetDelay: description: >- The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes. format: double type: number onsetDelayWithStrongestPearsonCorrelation: description: 'Example: -86400' type: integer onsetDelayWithStrongestPearsonCorrelationInHours: description: 'Example: -24' type: integer optimalPearsonProduct: description: Optimal Pearson Product type: number outcomeDataSources: description: original name of the cause. type: string outcomeFillingValue: description: 'Example: -1' type: integer pearsonCorrelationWithNoOnsetDelay: description: 'Example: 0.477' format: double type: number predictivePearsonCorrelation: description: 'Example: 0.538' format: double type: number predictivePearsonCorrelationCoefficient: description: 'Example: 0.538' format: double type: number predictorDataSources: description: 'Example: RescueTime' type: string predictorExplanation: description: HIGHER Remeron predicts HIGHER Overall Mood type: string predictorFillingValue: description: 'Example: -1' type: integer predictorMaximumAllowedValue: description: 'Example: 160934' format: double type: number predictorMinimumAllowedValue: description: 'Example: 10' format: double type: number predictsHighEffectChange: description: 'Example: 17' type: integer predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 17% ' type: string predictsLowEffectChange: description: 'Example: -11' type: integer predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 11% ' type: string principalInvestigator: description: Mike Sinn type: string pValue: description: 'Example: 3.5306635529222E-5' format: double type: number qmScore: description: >- Value representing the significance of the relationship as a function of crowdsourced insights, predictive strength, data quantity, and data quality type: number reverseCorrelation: description: >- Correlation when cause and effect are reversed. For any causal relationship, the forward correlation should exceed the reverse correlation. type: number reversePearsonCorrelationCoefficient: description: 'Example: 0.63628232030415' format: double type: number shareUserMeasurements: description: 'Example: 1' type: boolean significanceExplanation: description: >- Using a two-tailed t-test with alpha = 0.05, it was determined that the change... type: string significantDifference: description: 'Example: 1' type: boolean statisticalSignificance: description: A function of the effect size and sample size type: string strengthLevel: description: 'weak, moderate, strong' type: string strongestPearsonCorrelationCoefficient: description: 'Example: 0.613' format: double type: number studyAbstract: description: These data suggest with a high degree of confidence... type: string studyBackground: description: >- In order to reduce suffering through the advancement of human knowledge... type: string studyDesign: description: This study is based on data donated by one QuantiModo user... type: string studyLimitations: description: >- As with any human experiment, it was impossible to control for all potentially confounding variables... type: string studyLinkDynamic: description: Url for the interactive study within the web app type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Sleep%20Quality%20Predicts%20Higher%20Overall%20Mood&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Quality%26effectVariableName%3DOverall%2520Mood%26userId%3D230%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: Url for sharing the study on Facebook type: string studyLinkGoogle: description: Url for sharing the study on Google+ type: string studyLinkStatic: description: Url for sharing the statically rendered study on social media type: string studyLinkTwitter: description: Url for sharing the study on Twitter type: string studyObjective: description: The objective of this study is to determine... type: string studyResults: description: This analysis suggests that... type: string studyTitle: description: N1 Study HIGHER Remeron predicts HIGHER Overall Mood type: string timestamp: description: Time at which correlation was calculated type: number tValue: description: 'Example: 9.6986079652717' format: double type: number updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. format: date-time type: string updatedTime: description: 'Example: 2017-05-06 15:40:38' format: date-time type: string userId: description: 'Example: 230' type: integer userVote: description: User Vote type: number valuePredictingHighOutcome: description: >- cause value that predicts an above average effect value (in default unit for cause variable) type: number valuePredictingHighOutcomeExplanation: description: 'Overall Mood, on average, 34% HIGHER after around 3.98mg Remeron' type: string valuePredictingLowOutcome: description: >- cause value that predicts a below average effect value (in default unit for cause variable) type: number valuePredictingLowOutcomeExplanation: description: 'Overall Mood, on average, 4% LOWER after around 0mg Remeron' type: string required: - cause - correlationCoefficient - durationOfAction - effect - numberOfPairs - onsetDelay - timestamp UserStudy: properties: allPairsSignificance: description: 'Example: 1' format: double type: number averageDailyHighCause: description: 'Example: 8.8' format: double type: number averageDailyLowCause: description: 'Example: 5.93' format: double type: number averageEffect: description: 'Example: 2.7265782739077' format: double type: number averageEffectFollowingHighCause: description: 'Example: 2.62' format: double type: number averageEffectFollowingHighCauseExplanation: description: >- Example: Overall Mood is 2.62/5 (4% lower) on average after days with around 8.8 h Sleep Duration type: string averageEffectFollowingLowCause: description: 'Example: 2.82' format: double type: number averageEffectFollowingLowCauseExplanation: description: >- Example: Overall Mood is 2.82/5 (3% higher) on average after days with around 5.93 h Sleep Duration type: string causalityFactor: description: 'Example: -0.173' format: double type: number causeChanges: description: 'Example: 1010' type: integer causeChangesStatisticalSignificance: description: 'Example: 1' format: double type: number causeDataSource: $ref: '#/definitions/DataSource' causeNumberOfProcessedDailyMeasurements: description: 'Example: 1113' type: integer causeNumberOfRawMeasurements: description: 'Example: 1942' type: integer causeValueSpread: description: 'Example: 12.45' format: double type: number causeVariable: $ref: '#/definitions/UserVariable' causeVariableCategoryId: description: 'Example: 6' type: integer causeVariableCategoryName: description: 'Example: Sleep' type: string causeVariableUnitAbbreviatedName: description: 'Example: h' type: string causeVariableUnitId: description: 'Example: 34' type: integer causeVariableId: description: 'Example: 1867' type: integer causeVariableImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Household/sleeping_in_bed-96.png type: string causeVariableIonIcon: description: 'Example: ion-ios-cloudy-night-outline' type: string causeVariableMostCommonConnectorId: description: 'Example: 7' type: integer causeVariableName: description: 'Example: Sleep Duration' type: string charts: items: $ref: '#/definitions/Chart' type: array confidenceInterval: description: 'Example: 0.055165978848875' format: double type: number confidenceLevel: description: 'Example: high' type: string correlationCoefficient: description: 'Example: -0.173' format: double type: number correlationIsContradictoryToOptimalValues: description: 'Example: false' type: boolean criticalTValue: description: 'Example: 1.646' format: double type: number dataAnalysis: description: >- Example: It was assumed that 0 hours would pass before a change in Sleep Duration would produce an observable change in Overall Mood. It was assumed that Sleep Duration could produce an observable change in Overall Mood for as much as 7 days after the stimulus event. type: string dataSources: description: >- Example: Sleep Duration data was primarily collected using Fitbit. Fitbit makes activity tracking easy and automatic.
Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string dataSourcesParagraphForCause: description: >- Example: Sleep Duration data was primarily collected using Fitbit. Fitbit makes activity tracking easy and automatic. type: string dataSourcesParagraphForEffect: description: >- Example: Overall Mood data was primarily collected using QuantiModo. QuantiModo 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. QuantiModo then analyzes your data to identify which hidden factors are most likely to be influencing your mood or symptoms and their optimal daily values. type: string degreesOfFreedom: description: 'Example: 200' type: integer direction: description: 'Example: lower' type: string distanceFromMiddleToBeHightLowEffect: description: 'Example: 25' type: integer durationOfAction: description: 'Example: 604800' type: integer durationOfActionInHours: description: 'Example: 0' type: integer effectChanges: description: 'Example: 521' type: integer effectDataSource: $ref: '#/definitions/DataSource' effectNumberOfProcessedDailyMeasurements: description: 'Example: 1492' type: integer effectNumberOfRawMeasurements: description: 'Example: 11866' type: integer effectSize: description: 'Example: weakly negative' type: string effectUnit: description: 'Example: /5' type: string effectValueSpread: description: 'Example: 3.5' format: double type: number effectVariable: $ref: '#/definitions/UserVariable' effectVariableCategoryId: description: 'Example: 1' type: integer effectVariableCategoryName: description: 'Example: Emotions' type: string effectVariableUnitAbbreviatedName: description: 'Example: /5' type: string effectVariableUnitId: description: 'Example: 10' type: integer effectVariableId: description: 'Example: 1398' type: integer effectVariableImageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string effectVariableIonIcon: description: 'Example: ion-happy-outline' type: string effectVariableMostCommonConnectorId: description: 'Example: 5' type: integer effectVariableName: description: 'Example: Overall Mood' type: string error: description: 'Example: optimalPearsonProduct is not defined' type: string experimentEndTime: description: 'Example: 1491024591' type: integer experimentStartTime: description: 'Example: 1336267020' type: integer forwardSpearmanCorrelationCoefficient: description: 'Example: -0.20037947834262' format: double type: number gaugeImage: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-weakly-negative-relationship.png type: string gaugeImageSquare: description: >- Example: https://s3.amazonaws.com/quantimodo-docs/images/gauge-weakly-negative-relationship-200-200.png type: string imageUrl: description: >- Example: https://s3-us-west-1.amazonaws.com/qmimages/variable_categories_gauges_logo_background/gauge-weakly-negative-relationship_sleep_emotions_logo_background.png type: string instructionsForCause: description: >- Example: Obtain Fitbit and use it to record your Sleep Duration. Once you have a Fitbit account, connect your Fitbit account at QuantiModo to automatically import and analyze your data. type: string instructionsForEffect: description: >- Example: Obtain QuantiModo and use it to record your Overall Mood. Once you have a QuantiModo account, connect your QuantiModo account at QuantiModo to automatically import and analyze your data. type: string maximumCauseValue: description: 'Example: 13.75' format: double type: number maximumEffectValue: description: 'Example: 5' format: double type: number minimumCauseValue: description: 'Example: 1.3' format: double type: number minimumEffectValue: description: 'Example: 1.5' format: double type: number minimumProbability: description: 'Example: 0.05' format: double type: number numberOfCauseChangesForOptimalValues: description: 'Example: 1010' type: integer numberOfDays: description: 'Example: 1791' type: integer numberOfDaysSignificance: description: 'Example: 1' format: double type: number numberOfEffectChangesForOptimalValues: description: 'Example: 521' type: integer numberOfHighEffectPairs: description: 'Example: 28' type: integer numberOfLowEffectPairs: description: 'Example: 275' type: integer numberOfPairs: description: 'Example: 1011' type: integer numberOfSamples: description: 'Example: 1011' type: integer numberOfUniqueCauseValuesForOptimalValues: description: 'Example: 671' type: integer numberOfUniqueEffectValuesForOptimalValues: description: 'Example: 112' type: integer onsetDelay: description: 'Example: 0' type: integer onsetDelayInHours: description: 'Example: 0' type: integer optimalChangeSpread: description: 'Example: 6.79' format: double type: number optimalChangeSpreadSignificance: description: 'Example: 0.8959967711131' format: double type: number optimalPearsonProduct: description: 'Example: 0.074088026546601' format: double type: number predictivePearsonCorrelationCoefficient: description: 'Example: -0.173' format: double type: number predictorExplanation: description: 'Example: Sleep Duration Predicts Lower Overall Mood' type: string predictsHighEffectChange: description: 'Example: 3.54' format: double type: number predictsHighEffectChangeSentenceFragment: description: 'Example: , on average, 3.54% ' type: string predictsLowEffectChange: description: 'Example: -3.25' format: double type: number predictsLowEffectChangeSentenceFragment: description: 'Example: , on average, 3.25% ' type: string rawCauseMeasurementSignificance: description: 'Example: 1' format: double type: number rawEffectMeasurementSignificance: description: 'Example: 1' format: double type: number shareUserMeasurements: description: 'Example: false' type: boolean significanceExplanation: description: >- Example: Using a two-tailed t-test with alpha = 0.05, it was determined that the change in Overall Mood is statistically significant at 95% confidence interval. type: string significantDifference: description: 'Example: true' type: boolean statisticalSignificance: description: 'Example: 0.83333333333333' format: double type: number strengthLevel: description: 'Example: very weak' type: string studyAbstract: description: >- Example: Your data suggests with a high degree of confidence (p=0) that Sleep Duration (Sleep) has a weakly negative predictive relationship (R=-0.173) with Overall Mood (Emotions). The highest quartile of Overall Mood measurements were observed following an average 6.79h Sleep Duration. The lowest quartile of Overall Mood measurements were observed following an average 7.54h Sleep Duration. type: string studyDesign: description: >- Example: This study is based on data donated by one QuantiModo user. Thus, the study design is consistent with an n=1 observational natural experiment. type: string studyLimitations: description: >- Example: As with any human experiment, it was impossible to control for all potentially confounding variables. Correlation does not necessarily imply correlation. We can never know for sure if one factor is definitely the cause of an outcome. However, lack of correlation definitely implies the lack of a causal relationship. Hence, we can with great confidence rule out non-existent relationships. For instance, if we discover no relationship between mood and an antidepressant this information is just as or even more valuable than the discovery that there is a relationship.

We can also take advantage of several characteristics of time series data from many subjects to infer the likelihood of a causal relationship if we do find a correlational relationship. The criteria for causation are a group of minimal conditions necessary to provide adequate evidence of a causal relationship between an incidence and a possible consequence. The list of the criteria is as follows:
1. Strength (effect size): A small association does not mean that there is not a causal effect, though the larger the association, the more likely that it is causal.
2. Consistency (reproducibility): Consistent findings observed by different persons in different places with different samples strengthens the likelihood of an effect.
3. Specificity: Causation is likely if a very specific population at a specific site and disease with no other likely explanation. The more specific an association between a factor and an effect is, the bigger the probability of a causal relationship.
4. Temporality: The effect has to occur after the cause (and if there is an expected delay between the cause and expected effect, then the effect must occur after that delay).
5. Biological gradient: Greater exposure should generally lead to greater incidence of the effect. However, in some cases, the mere presence of the factor can trigger the effect. In other cases, an inverse proportion is observed: greater exposure leads to lower incidence.
6. Plausibility: A plausible mechanism between cause and effect is helpful.
7. Coherence: Coherence between epidemiological and laboratory findings increases the likelihood of an effect.
8. Experiment: "Occasionally it is possible to appeal to experimental evidence".
9. Analogy: The effect of similar factors may be considered.

The confidence in a causal relationship is bolstered by the fact that time-precedence was taken into account in all calculations. Furthermore, in accordance with the law of large numbers (LLN), the predictive power and accuracy of these results will continually grow over time. 1011 paired data points were used in this analysis. Assuming that the relationship is merely coincidental, as the participant independently modifies their Sleep Duration values, the observed strength of the relationship will decline until it is below the threshold of significance. To it another way, in the case that we do find a spurious correlation, suggesting that banana intake improves mood for instance, one will likely increase their banana intake. Due to the fact that this correlation is spurious, it is unlikely that you will see a continued and persistent corresponding increase in mood. So over time, the spurious correlation will naturally dissipate.Furthermore, it will be very enlightening to aggregate this data with the data from other participants with similar genetic, diseasomic, environmentomic, and demographic profiles. type: string studyLinkDynamic: description: >- Example: https://local.quantimo.do/ionic/Modo/www/index.html#/app/study?causeVariableName=Sleep%20Duration&effectVariableName=Overall%20Mood&userId=230 type: string studyLinkEmail: description: >- Example: mailto:?subject=N1%20Study%3A%20Sleep%20Duration%20Predicts%20Lower%20Overall%20Mood&body=Check%20out%20my%20study%20at%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Duration%26effectVariableName%3DOverall%2520Mood%26userId%3D230%0A%0AHave%20a%20great%20day! type: string studyLinkFacebook: description: >- Example: https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Duration%26effectVariableName%3DOverall%2520Mood%26userId%3D230 type: string studyLinkGoogle: description: >- Example: https://plus.google.com/share?url=https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Duration%26effectVariableName%3DOverall%2520Mood%26userId%3D230 type: string studyLinkStatic: description: >- Example: https://local.quantimo.do/api/v2/study?causeVariableName=Sleep%20Duration&effectVariableName=Overall%20Mood&userId=230 type: string studyLinkTwitter: description: >- Example: https://twitter.com/home?status=Sleep%20Duration%20Predicts%20Lower%20Overall%20Mood%20https%3A%2F%2Flocal.quantimo.do%2Fapi%2Fv2%2Fstudy%3FcauseVariableName%3DSleep%2520Duration%26effectVariableName%3DOverall%2520Mood%26userId%3D230%20%40quantimodo type: string studyObjective: description: >- Example: The objective of this study is to determine the nature of the relationship (if any) between the Sleep Duration and the Overall Mood. Additionally, we attempt to determine the Sleep Duration values most likely to produce optimal Overall Mood values. type: string studyResults: description: >- Example: This analysis suggests that higher Sleep Duration (Sleep) generally predicts lower Overall Mood (p = 0). Overall Mood is, on average, 3.54% higher after around 6.79 Sleep Duration. After an onset delay of 168 hours, Overall Mood is, on average, 3.25% lower than its average over the 168 hours following around 7.54 Sleep Duration. 1011 data points were used in this analysis. The value for Sleep Duration changed 1010 times, effectively running 505 separate natural experiments. The top quartile outcome values are preceded by an average 6.79 h of Sleep Duration. The bottom quartile outcome values are preceded by an average 7.54 h of Sleep Duration. Forward Pearson Correlation Coefficient was -0.173 (p=0, 95% CI -0.228 to -0.118 onset delay = 0 hours, duration of action = 168 hours) . The Reverse Pearson Correlation Coefficient was 0 (P=0, 95% CI -0.055 to 0.055, onset delay = -0 hours, duration of action = -168 hours). When the Sleep Duration value is closer to 6.79 h than 7.54 h, the Overall Mood value which follows is, on average, 3.54% percent higher than its typical value. When the Sleep Duration value is closer to 7.54 h than 6.79 h, the Overall Mood value which follows is 0% lower than its typical value. Overall Mood is 2.62/5 (4% lower) on average after days with around 8.8 h Sleep Duration Overall Mood is 2.82/5 (3% higher) on average after days with around 5.93 h Sleep Duration type: string studyTitle: description: 'Example: N1 Study: Sleep Duration Predicts Lower Overall Mood' type: string timestamp: description: 'Example: 1502255174' type: integer tValue: description: 'Example: 5.525102310162' format: double type: number userId: description: 'Example: 230' type: integer valuePredictingHighOutcome: description: 'Example: 6.79' format: double type: number valuePredictingHighOutcomeExplanation: description: >- Example: Overall Mood, on average, 3.54% higher after around 6.79 h Sleep Duration type: string valuePredictingLowOutcome: description: 'Example: 7.54' format: double type: number valuePredictingLowOutcomeExplanation: description: >- Example: Overall Mood, on average, 3.25% lower after around 7.54 h Sleep Duration type: string voteStatisticalSignificance: description: 'Example: 0.83333333333333' format: double type: number UserTag: properties: conversionFactor: description: >- Number by which we multiply the tagged variable value to obtain the tag variable (ingredient) value type: number taggedVariableId: description: >- This is the id of the variable being tagged with an ingredient or something. type: integer tagVariableId: description: >- This is the id of the ingredient variable whose value is determined based on the value of the tagged variable. type: integer required: - conversionFactor - tagVariableId - taggedVariableId UserVariable: properties: alias: description: 'Example: ' type: string availableUnits: items: $ref: '#/definitions/Unit' type: array causeOnly: description: >- A value of 1 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 type: boolean chartsLinkDynamic: description: >- Example: 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 type: string chartsLinkEmail: description: >- Example: 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! type: string chartsLinkFacebook: description: >- Example: 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 type: string chartsLinkGoogle: description: >- Example: 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 type: string chartsLinkStatic: description: >- Example: 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 type: string chartsLinkTwitter: description: >- Example: 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%40quantimodo type: string childUserTagVariables: $ref: '#/definitions/UserVariableArray' clientId: description: clientId type: string combinationOperation: description: 'Example: MEAN' type: string commonAlias: description: 'Example: Anxiety / Nervousness' type: string commonTaggedVariables: $ref: '#/definitions/CommonVariableArray' commonTagVariables: $ref: '#/definitions/CommonVariableArray' commonVariableMostCommonConnectorId: description: 'Example: 51' type: integer commonVariableUpdatedAt: description: 'Example: 2017-02-07 23:43:39' format: date-time type: string createdAt: description: >- When the record was first created. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string unitAbbreviatedName: description: 'Example: count' type: string unitCategoryId: description: 'Example: 6' type: integer unitCategoryName: description: 'Example: Miscellany' type: string unitId: description: ID of unit to use for this variable format: int32 type: integer unitName: description: 'Example: Count' type: string description: description: 'Example: negative' type: string durationOfAction: description: >- The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. format: int32 type: integer durationOfActionInHours: description: 'Example: 168' type: integer earliestFillingTime: description: Earliest filling time format: int32 type: integer earliestMeasurementTime: description: Earliest measurement time format: int32 type: integer earliestSourceTime: description: Earliest source time format: int32 type: integer errorMessage: description: error_message type: string experimentEndTime: description: >- Latest measurement start_time to be used in analysis. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string experimentEndTimeSeconds: description: 'Example: 1893477600' type: integer experimentEndTimeString: description: 'Example: 2030-01-01 06:00:00' format: date-time type: string experimentStartTime: description: >- Earliest measurement start_time to be used in analysis. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string experimentStartTimeSeconds: description: 'Example: 1269307902' type: integer experimentStartTimeString: description: 'Example: 2010-03-23 01:31:42' format: date-time type: string fillingType: description: '0 -> No filling, 1 -> Use filling-value' type: string fillingValue: description: >- 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. format: float type: number iconIcon: description: 'Example: ion-sad-outline' type: string highcharts: $ref: '#/definitions/HighchartArray' id: description: 'Example: 95614' type: integer imageUrl: description: '' type: string informationalUrl: description: 'Example: ' type: string ingredientOfUserTagVariables: $ref: '#/definitions/UserVariableArray' ingredientUserTagVariables: $ref: '#/definitions/UserVariableArray' inputType: description: 'Example: value' type: string ionIcon: description: '' type: string joinedUserTagVariables: $ref: '#/definitions/UserVariableArray' joinWith: description: >- The Variable this Variable should be joined with. If the variable is joined with some other variable then it is not shown to user in the list of variables format: int32 type: integer kurtosis: description: Kurtosis format: float type: number lastOriginalUnitId: description: ID of last original Unit format: int32 type: integer lastOriginalValue: description: Last original value which is stored format: int32 type: integer lastProcessedDailyValue: description: 'Example: 500' format: double type: number lastSuccessfulUpdateTime: description: When this variable or its settings were last updated format: date-time type: string lastUnitId: description: ID of last Unit format: int32 type: integer lastValue: description: Last Value format: float type: number latestFillingTime: description: Latest filling time format: int32 type: integer latestMeasurementTime: description: Latest measurement time format: int32 type: integer latestSourceTime: description: Latest source time format: int32 type: integer latestUserMeasurementTime: description: 'Example: 1501383600' type: integer latitude: description: Latitude format: float type: number location: description: Location type: string longitude: description: Longitude format: float type: number manualTracking: description: 'Example: 1' type: boolean maximumAllowedValue: description: >- The maximum allowed value for measurements. While you can record a value above this maximum, it will be excluded from the correlation analysis. format: float type: number maximumRecordedDailyValue: description: Maximum recorded daily value of this variable format: float type: number maximumRecordedValue: description: 'Example: 1' format: double type: number mean: description: Mean format: float type: number measurementsAtLastAnalysis: description: Number of measurements at last analysis format: int32 type: integer median: description: Median format: float type: number minimumAllowedValue: description: >- The minimum allowed value for measurements. While you can record a value below this minimum, it will be excluded from the correlation analysis. format: float type: number minimumRecordedValue: description: Minimum recorded value of this variable format: float type: number mostCommonConnectorId: description: 'Example: 51' type: integer mostCommonOriginalUnitId: description: 'Example: 23' type: integer mostCommonUnitId: description: Most common Unit ID format: int32 type: integer mostCommonValue: description: Most common value format: float type: number name: description: 'Example: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)' type: string numberOfAggregateCorrelationsAsCause: description: 'Example: 1' type: integer numberOfAggregateCorrelationsAsEffect: description: 'Example: 310' type: integer numberOfChanges: description: Number of changes format: int32 type: integer numberOfCorrelations: description: Number of correlations for this variable format: int32 type: integer numberOfMeasurements: description: Number of measurements format: int32 type: integer numberOfProcessedDailyMeasurements: description: Number of processed measurements format: int32 type: integer numberOfRawMeasurements: description: 'Example: 295' type: integer numberOfTrackingReminders: description: 'Example: 1' type: integer numberOfUniqueDailyValues: description: Number of unique daily values format: float type: number numberOfUniqueValues: description: 'Example: 2' type: integer numberOfUserCorrelationsAsCause: description: 'Example: 115' type: integer numberOfUserCorrelationsAsEffect: description: 'Example: 29014' type: integer numberOfUserVariables: description: 'Example: 2' type: integer onsetDelay: description: >- The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes. format: int32 type: integer onsetDelayInHours: description: 'Example: 0.5' format: double type: number outcome: description: >- Outcome variables (those with `outcome` == 1) are 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 type: boolean outcomeOfInterest: description: 'Example: 1' type: integer parent: description: 'Example: ' type: string parentId: description: ID of the parent variable if this variable has any parent format: int32 type: integer parentUserTagVariables: $ref: '#/definitions/UserVariableArray' pngPath: description: 'Example: img/variable_categories/treatments.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.png type: string predictorOfInterest: description: 'Example: 0' type: integer price: description: 'Example: 95.4' format: double type: number productUrl: description: 'Example: ' type: string public: description: Is variable public format: int32 type: integer rawMeasurementsAtLastAnalysis: description: 'Example: 131' type: integer secondMostCommonValue: description: 'Example: 1' format: double type: number secondToLastValue: description: 'Example: 250' format: double type: number shareUserMeasurements: description: 'Example: 1' type: boolean skewness: description: Skewness format: float type: number sources: description: >- Comma-separated list of source names to limit variables to those sources type: string standard_deviation: description: Standard deviation format: float type: number standardDeviation: description: 'Example: 0.46483219855434' format: double type: number status: description: status type: string svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/treatments.svg type: string thirdMostCommonValue: description: 'Example: 6' format: double type: number thirdToLastValue: description: 'Example: 250' format: double type: number unit: $ref: '#/definitions/Unit' updated: description: updated format: int32 type: integer updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string updatedTime: description: 'Example: 2017-07-30 14:58:26' format: date-time type: string userId: description: User ID format: int32 type: integer userTaggedVariables: $ref: '#/definitions/UserVariableArray' userTagVariables: $ref: '#/definitions/UserVariableArray' userVariableUnitAbbreviatedName: description: 'Example: count' type: string userVariableUnitCategoryId: description: 'Example: 6' type: integer userVariableUnitCategoryName: description: 'Example: Miscellany' type: string userVariableUnitId: description: 'Example: 23' type: integer userVariableUnitName: description: 'Example: Count' type: string userVariableFillingValue: description: 'Example: -1' format: double type: number userVariableMostCommonConnectorId: description: 'Example: 51' type: integer userVariableUpdatedAt: description: 'Example: 2017-07-30 14:58:26' format: date-time type: string userVariableValence: description: 'Example: ' type: string userVariableVariableCategoryId: description: 'Example: 13' type: integer userVariableVariableCategoryName: description: 'Example: Treatments' type: string userVariableWikipediaTitle: description: 'Example: ' type: string valence: description: 'Example: negative' type: string variableCategory: $ref: '#/definitions/VariableCategory' variableCategoryId: description: ID of variable category format: int32 type: integer variableCategoryImageUrl: description: 'Example: https://maxcdn.icons8.com/Color/PNG/96/Healthcare/pill-96.png' type: string variableCategoryName: description: 'Example: Treatments' type: string variableFillingValue: description: 'Example: -1' format: double type: number variableId: description: ID of variable format: int32 type: integer variableName: description: 'Example: Trader Joes Bedtime Tea / Sleepytime Tea (any Brand)' type: string variance: description: Variance format: float type: number wikipediaTitle: description: 'Example: ' type: string required: - alias - availableUnits - childUserTagVariables - commonTagVariables - commonTaggedVariables - informationalUrl - ingredientOfUserTagVariables - ingredientUserTagVariables - joinedUserTagVariables - parent - parentUserTagVariables - price - productUrl - userTagVariables - userTaggedVariables - userVariableValence - userVariableWikipediaTitle - variableId - wikipediaTitle UserVariableArray: items: $ref: '#/definitions/UserVariable' type: array UserVariableDelete: properties: variableId: description: Id of the variable whose measurements should be deleted type: integer required: - variableId VariableCategory: properties: appType: description: 'Example: mood' type: string causeOnly: description: 'Example: false' type: boolean combinationOperation: description: 'Example: MEAN' type: string createdTime: description: 'Example: ' format: date-time type: string unitAbbreviatedName: description: 'Example: /5' type: string unitId: description: 'Example: 10' type: integer durationOfAction: description: 'Example: 86400' type: integer fillingValue: description: 'Example: -1' type: integer helpText: description: 'Example: What emotion do you want to rate?' type: string id: description: 'Example: 1' type: integer imageUrl: description: >- Example: https://maxcdn.icons8.com/Color/PNG/96/Cinema/theatre_mask-96.png type: string ionIcon: description: 'Example: ion-happy-outline' type: string manualTracking: description: 'Example: true' type: boolean maximumAllowedValue: description: 'Example: ' type: string measurementSynonymSingularLowercase: description: 'Example: rating' type: string minimumAllowedValue: description: 'Example: ' type: string moreInfo: description: >- Example: Do you have any emotions that fluctuate regularly? If so, add them so I can try to determine which factors are influencing them. type: string name: description: Category name type: string onsetDelay: description: 'Example: 0' type: integer outcome: description: 'Example: true' type: boolean pngPath: description: 'Example: img/variable_categories/emotions.png' type: string pngUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.png type: string public: description: 'Example: true' type: boolean svgPath: description: 'Example: img/variable_categories/emotions.svg' type: string svgUrl: description: >- Example: https://app.quantimo.do/ionic/Modo/www/img/variable_categories/emotions.svg type: string updated: description: 'Example: 1' type: integer updatedTime: description: 'Example: ' format: date-time type: string variableCategoryName: description: 'Example: Emotions' type: string variableCategoryNameSingular: description: 'Example: Emotion' type: string required: - name VariableCategoryArray: items: $ref: '#/definitions/VariableCategory' type: array Vote: properties: causeVariableId: description: Cause variable id type: integer clientId: description: clientId type: string createdAt: description: >- When the record was first created. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string effectVariableId: description: Effect variable id type: integer id: description: id format: int32 type: integer updatedAt: description: >- When the record in the database was last updated. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format format: date-time type: string userId: description: ID of User format: int32 type: integer value: description: 'Vote: 0 (for implausible) or 1 (for plausible)' type: boolean required: - causeVariableId - clientId - effectVariableId - userId - value VoteDelete: properties: cause: description: Cause variable name for the correlation to which the vote pertains type: string effect: description: Effect variable name for the correlation to which the vote pertains type: string required: - cause - effect XAxi: properties: categories: items: type: string type: array endOnTick: description: 'Example: true' type: boolean showLastLabel: description: 'Example: true' type: boolean startOnTick: description: 'Example: true' type: boolean text: description: 'Example: Date' type: string title: $ref: '#/definitions/Title' required: - categories - endOnTick - showLastLabel - startOnTick - text - title YAxi: properties: lineWidth: description: 'Example: 1' type: integer max: description: 'Example: 372.68' format: double type: number min: description: 'Example: -2.68' format: double type: number opposite: description: 'Example: true' type: boolean title: $ref: '#/definitions/Title' required: - lineWidth - max - min - opposite - title host: app.quantimo.do info: contact: name: info@quantimo.do description: >- We make it easy to retrieve and analyze normalized user data from a wide array of devices and applications. Check out our [docs and sdk's](https://github.com/QuantiModo/docs) or [contact us](https://help.quantimo.do). license: name: Apache 2.0 url: 'http://www.apache.org/licenses/LICENSE-2.0.html' termsOfService: 'https://quantimo.do/tos/' title: quantimodo version: 5.8.100411 parameters: appNameParam: description: 'Example: MoodiModo' in: query name: appName required: false type: string appVersionParam: description: 'Example: 2.1.1.0' in: query name: appVersion required: false type: string causeUnitNameParam: description: Name for the unit cause measurements to be returned in in: query name: causeUnitName required: false type: string causeVariableNameParam: description: 'Variable name of the hypothetical cause variable. Example: Sleep Duration' in: query name: causeVariableName required: false type: string clientIdParam: description: 'Example: oauth_test_client' in: query name: clientId required: false type: string clientSecretParam: description: >- This is the secret for your obtained clientId. We use this to ensure that only your application uses the clientId. Obtain this by creating a free application at [https://app.quantimo.do/api/v2/apps](https://app.quantimo.do/api/v2/apps). in: query name: client_secret required: true type: string clientUserIdParam: description: 'Example: 74802' in: query name: clientUserId required: false type: integer codeParam: description: Authorization code you received with the previous request. in: query name: code required: true type: string connectorNamePathParam: description: >- Lowercase system name of the source application or device. Get a list of available connectors from the /v3/connectors/list endpoint. enum: - facebook - fitbit - github - googlecalendar - googlefit - medhelper - mint - moodpanda - moodscope - myfitnesspal - mynetdiary - netatmo - rescuetime - runkeeper - slack - sleepcloud - slice - up - whatpulse - withings - worldweatheronline in: path name: connectorName required: true type: string correlationCoefficientParam: description: >- Pearson correlation coefficient between cause and effect after lagging by onset delay and grouping by duration of action in: query name: correlationCoefficient required: false type: string createdAtParam: description: >- When the record was first created. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. in: query name: createdAt required: false type: string doNotConvertParam: description: 'Example: 1' in: query name: doNotConvert required: false type: boolean doNotCreateNewCommonVariablesParam: description: 'Example: ' in: query name: doNotCreateNewCommonVariables required: false type: boolean doNotProcessParam: description: 'Example: true' in: query name: doNotProcess required: false type: boolean durationOfActionParam: description: >- The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. in: query name: durationOfAction required: false type: string earliestMeasurementTimeParam: description: >- Excluded records with measurement times earlier than this value. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. in: query name: earliestMeasurementTime required: false type: string effectOrCauseParam: description: 'Example: ' in: query name: effectOrCause required: false type: string effectUnitNameParam: description: Name for the unit effect measurements to be returned in in: query name: effectUnitName required: false type: string effectVariableNameParam: description: 'Variable name of the hypothetical effect variable. Example: Overall Mood' in: query name: effectVariableName required: false type: string exactMatchParam: description: 'Example: ' in: query name: exactMatch required: false type: boolean fallbackToAggregateCorrelationsParam: description: 'Example: true' in: query name: fallbackToAggregateCorrelations required: false type: boolean fallbackToAggregatedCorrelationsParam: description: 'Example: true' in: query name: fallbackToAggregatedCorrelations required: false type: boolean fallbackToStudyForCauseAndEffectParam: description: 'Example: 1' in: query name: fallbackToStudyForCauseAndEffect required: false type: boolean grantTypeParam: description: Grant Type can be 'authorization_code' or 'refresh_token' in: query name: grant_type required: true type: string groupingTimezoneParam: description: The time (in seconds) over which measurements are grouped together in: query name: groupingTimezone required: false type: string groupingWidthParam: description: The time (in seconds) over which measurements are grouped together in: query name: groupingWidth required: false type: integer includeChartsParam: description: 'Example: true' in: query name: includeCharts required: false type: boolean includeDeletedParam: description: 'Example: ' in: query name: includeDeleted required: false type: boolean includePrivateParam: description: 'Example: ' in: query name: includePrivate required: false type: boolean includePublicParam: description: 'Example: true' in: query name: includePublic required: false type: boolean includeTagsParam: description: 'Example: true' in: query name: includeTags required: false type: boolean lastSourceParam: description: >- Limit variables to those which measurements were last submitted by a specific source. So if you have a client application and you only want variables that were last updated by your app, you can include the name of your app here in: query name: lastSourceName required: false type: string latestMeasurementTimeParam: description: >- Excluded records with measurement times later than this value. Use UTC ISO 8601 `YYYY-MM-DDThh:mm:ss` datetime format. Time zone should be UTC and not local. in: query name: latestMeasurementTime required: false type: string limitParam: default: 100 description: >- 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. in: query name: limit required: false type: integer manualTrackingParam: description: 'Example: ' in: query name: manualTracking required: false type: boolean maximumReminderTimeUtcStringParam: description: 'Example: 2017-08-08T23:20:11+00:00' in: query name: maximumReminderTimeUtcString required: false type: string minimumReminderTimeUtcStringParam: description: 'Example: 2017-08-06T23:20:11+00:00' in: query name: minimumReminderTimeUtcString required: false type: string minMaxFilterParam: description: 'Example: 1' in: query name: minMaxFilter required: false type: boolean numberOfAggregatedCorrelationsAsEffectParam: description: 'Example: (gt)1' in: query name: numberOfAggregatedCorrelationsAsEffect required: false type: string numberOfRawMeasurementsParam: description: >- Filter variables by the total number of measurements that they have. This could be used of you want to filter or sort by popularity. in: query name: numberOfRawMeasurements required: false type: string numberOfUserCorrelationsAsCauseParam: description: 'Example: (gt)1' in: query name: numberOfUserCorrelationsAsCause required: false type: string numberOfUserCorrelationsAsEffectParam: description: 'Example: (gt)1' in: query name: numberOfUserCorrelationsAsEffect required: false type: string offsetParam: description: >- 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. in: query minimum: 0 name: offset required: false type: integer onlyPastParam: description: 'Example: 1' in: query name: onlyPast required: false type: boolean onsetDelayParam: description: >- The amount of time in seconds that elapses after the predictor/stimulus event before the outcome as perceived by a self-tracker is known as the onset delay. For example, the onset delay between the time a person takes an aspirin (predictor/stimulus event) and the time a person perceives a change in their headache severity (outcome) is approximately 30 minutes. in: query name: onsetDelay required: false type: string outcomeParam: description: 'Example: true' in: query name: outcome required: false type: boolean outcomesOfInterestParam: description: >- Only include correlations for which the effect is an outcome of interest for the user in: query name: outcomesOfInterest required: false type: boolean publicEffectOrCauseParam: description: 'Example: ' in: query name: publicEffectOrCause required: false type: string redirectUriParam: description: >- The redirect URI is the URL within your client application that will receive the OAuth2 credentials. in: query name: redirect_uri required: false type: string reminderFrequencyParam: description: 'How often user should be reminded in seconds. Example: 86400' in: query name: reminderFrequency required: false type: string reminderStartTimeParam: description: 'Example: 20:00:00' in: query name: reminderStartTime required: false type: string reminderTimeParam: description: 'Example: (lt)2017-07-31 21:43:26' in: query name: reminderTime required: false type: string responseTypeParam: description: >- If the value is code, launches a Basic flow, requiring a POST to the token endpoint to obtain the tokens. If the value is token id_token or id_token token, launches an Implicit flow, requiring the use of Javascript at the redirect URI to retrieve tokens from the URI #fragment. in: query name: response_type required: true type: string scopeParam: description: >- Scopes include basic, readmeasurements, and writemeasurements. The `basic` scope allows you to read user info (displayName, email, etc). The `readmeasurements` scope allows one to read a user's data. The `writemeasurements` scope allows you to write user data. Separate multiple scopes by a space. in: query name: scope required: true type: string searchPhraseParam: description: 'Example: %Body Fat%' in: query name: searchPhrase required: false type: string sortParam: description: >- Sort by one of the listed field names. If the field name is prefixed with `-`, it will sort in descending order. in: query name: sort required: false type: string sourceNameParam: description: >- ID of the source you want measurements for (supports exact name match only) in: query name: sourceName required: false type: string startTrackingDateParam: description: 'Example: 2017-08-07' in: query name: startTrackingDate required: false type: string stateParam: description: >- An opaque string that is round-tripped in the protocol; that is to say, it is returned as a URI parameter in the Basic flow, and in the URI in: query name: state required: false type: string stopTrackingDateParam: description: 'Example: 2117-08-07' in: query name: stopTrackingDate required: false type: string synonymsParam: description: 'Example: %McDonalds hotcake%' in: query name: synonyms required: false type: string taggedVariableIdParam: description: >- This is the id of the variable being tagged with an ingredient or something. in: query name: taggedVariableId required: true type: integer tagVariableIdParam: description: >- This is the id of the ingredient variable whose value is determined based on the value of the tagged variable. in: query name: tagVariableId required: true type: integer unitAbbreviatedNameParam: description: 'Example: /5' in: query name: unitAbbreviatedName required: false type: string unitIdParam: description: 'Example: 10' in: query name: unitId required: false type: integer unitNameParam: description: 'Example: 86400' enum: - '% Recommended Daily Allowance' - '-4 to 4 Rating' - 0 to 1 Rating - 0 to 5 Rating - 1 to 10 Rating - 1 to 5 Rating - Applications - Beats per Minute - Calories - Capsules - Centimeters - Count - Degrees Celsius - Degrees East - Degrees Fahrenheit - Degrees North - Dollars - Drops - Event - Feet - Grams - Hours - Inches - Index - Kilocalories - Kilograms - Kilometers - Liters - Meters - Micrograms - Micrograms per decilitre - Miles - Milligrams - Milliliters - Millimeters - Millimeters Merc - Milliseconds - Minutes - Pascal - Percent - Pieces - Pills - Pounds - Puffs - Seconds - Serving - Sprays - Tablets - Torr - Units - Yes/No - per Minute in: query name: unitName required: false type: string updatedAtParam: description: >- 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. in: query name: updatedAt required: false type: string userIdParam: description: User's id in: query name: userId required: false type: number userVariablesParam: description: Variable user settings data in: body name: userVariables required: true schema: items: $ref: '#/definitions/UserVariable' type: array valueParam: description: Value of measurement in: query name: value required: false type: string variableCategoryIdParam: description: 'Example: 13' in: query name: variableCategoryId required: false type: integer variableCategoryNameParam: description: Limit results to a specific variable category enum: - Activity - Books - Causes of Illness - Cognitive Performance - Conditions - Emotions - Environment - Foods - Location - Miscellaneous - Movies and TV - Music - Nutrients - Payments - Physical Activity - Physique - Sleep - Social Interactions - Software - Symptoms - Treatments - Vital Signs - Work in: query name: variableCategoryName required: false type: string variableIdBodyParam: description: Id of the variable whose measurements should be deleted in: body name: variableId required: true schema: $ref: '#/definitions/UserVariableDelete' variableNameParam: description: Name of the variable you want measurements for in: query name: variableName required: false type: string paths: /v2/measurements/exportRequest: post: description: >- Use this endpoint to schedule a CSV export containing all user measurements to be emailed to the user within 24 hours. operationId: measurementExportRequest parameters: - $ref: '#/parameters/userIdParam' produces: - application/json responses: '201': description: successful operation schema: type: integer security: - access_token: [] - quantimodo_oauth2: - basic summary: Post Request for Measurements CSV tags: - measurements /v3/aggregatedCorrelations: get: description: >- Get correlations based on the anonymized aggregate data from all QuantiModo users. operationId: getAggregatedCorrelations parameters: - $ref: '#/parameters/durationOfActionParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/causeVariableNameParam' - $ref: '#/parameters/correlationCoefficientParam' - $ref: '#/parameters/onsetDelayParam' - $ref: '#/parameters/effectVariableNameParam' - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/outcomesOfInterestParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/AggregatedCorrelationArray' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get aggregated correlations tags: - analytics post: description: Add correlation operationId: postAggregatedCorrelations parameters: - $ref: '#/parameters/userIdParam' - description: Provides correlation data in: body name: body required: true schema: $ref: '#/definitions/PostCorrelation' produces: - application/json responses: '201': description: Successful Operation '400': description: Bad request schema: $ref: '#/definitions/JsonErrorResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Store or Update a Correlation tags: - analytics /v3/connect/mobile: get: description: >- This page is designed to be opened in a webview. Instead of using popup authentication boxes, it uses redirection. You can include the user's access_token as a URL parameter like https://app.quantimo.do/api/v3/connect/mobile?access_token=123 operationId: getMobileConnectPage parameters: - $ref: '#/parameters/userIdParam' produces: - text/html responses: '200': description: Mobile connect page was returned '401': description: User token is missing '403': description: User token is incorrect summary: Mobile connect page tags: - connectors /v3/connectors/list: get: description: >- A connector pulls data from other data providers using their API or a screenscraper. Returns a list of all available connectors and information about them such as their id, name, whether the user has provided access, logo url, connection instructions, and the update history. operationId: getConnectors parameters: - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/GetConnectorsResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: List of Connectors tags: - connectors '/v3/connectors/{connectorName}/connect': get: description: >- Attempt to obtain a token from the data provider, store it in the database. With this, the connector to continue to obtain new user data until the token is revoked. operationId: connectConnector parameters: - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/connectorNamePathParam' produces: - application/json responses: '200': description: Successful operation '401': description: Not Authenticated '404': description: Method not found. Could not execute the requested method. '500': description: Error during update. Unsupported response from update(). security: - access_token: [] - quantimodo_oauth2: - basic summary: Obtain a token from 3rd party data source tags: - connectors '/v3/connectors/{connectorName}/disconnect': get: description: >- The disconnect method deletes any stored tokens or connection information from the connectors database. operationId: disconnectConnector parameters: - $ref: '#/parameters/connectorNamePathParam' produces: - application/json responses: '200': description: Successful operation '401': description: Not Authenticated '404': description: Method not found. Could not execute the requested method. '500': description: Error during update. Unsupported response from update(). security: - access_token: [] - quantimodo_oauth2: - basic summary: Delete stored connection info tags: - connectors '/v3/connectors/{connectorName}/update': get: description: >- The update method tells the QM Connector Framework to check with the data provider (such as Fitbit or MyFitnessPal) and retrieve any new measurements available. operationId: updateConnector parameters: - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/connectorNamePathParam' produces: - application/json responses: '200': description: Connection Successful '401': description: Not Authenticated '404': description: Method not found. Could not execute the requested method. '500': description: Error during update. Unsupported response from update(). security: - access_token: [] - quantimodo_oauth2: - basic summary: Sync with data source tags: - connectors /v3/correlations: get: description: Get correlations based on data from a single user. operationId: getUserCorrelations parameters: - $ref: '#/parameters/limitParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/causeVariableNameParam' - $ref: '#/parameters/correlationCoefficientParam' - $ref: '#/parameters/onsetDelayParam' - $ref: '#/parameters/durationOfActionParam' - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/effectVariableNameParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/outcomesOfInterestParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/fallbackToStudyForCauseAndEffectParam' - $ref: '#/parameters/fallbackToAggregateCorrelationsParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/GetCorrelationsResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get correlations tags: - analytics /v3/correlations/explanations: get: description: Get explanations of correlations based on data from a single user. operationId: getUserCorrelationExplantions parameters: - $ref: '#/parameters/effectVariableNameParam' - $ref: '#/parameters/causeVariableNameParam' produces: - application/json responses: '200': description: Successful Operation schema: items: $ref: '#/definitions/UserCorrelation' type: array '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get correlation explanations tags: - analytics /v3/deviceTokens: post: description: Post DeviceTokens operationId: postDeviceTokens parameters: [] produces: - application/json responses: '201': description: Successful operation '401': description: Not authenticated '404': description: Not found '500': description: Internal server error summary: Post DeviceTokens tags: - notifications /v3/googleIdToken: post: description: Post GoogleIdToken operationId: postGoogleIdToken parameters: [] produces: - application/json responses: '201': description: Successful operation '401': description: Not authenticated '404': description: Not found '500': description: Internal server error summary: Post GoogleIdToken tags: - authentication /v3/integration.js: get: description: |- Get embeddable connect javascript. Usage: - Embedding in applications with popups for 3rd-party authentication windows. Use `qmSetupInPopup` function after connecting `connect.js`. - Embedding in applications with popups for 3rd-party authentication windows. Requires a selector to block. It will be embedded in this block. Use `qmSetupOnPage` function after connecting `connect.js`. - Embedding in mobile applications without popups for 3rd-party authentication. Use `qmSetupOnMobile` function after connecting `connect.js`. If using in a Cordova application call `qmSetupOnIonic` function after connecting `connect.js`. operationId: getIntegrationJs parameters: - $ref: '#/parameters/clientIdParam' produces: - application/x-javascript responses: '200': description: Embeddable connect javascript was returned summary: Get embeddable connect javascript tags: - connectors /v3/measurements: get: description: >- Measurements are any value that can be recorded like daily steps, a mood rating, or apples eaten. operationId: getMeasurements parameters: - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/variableNameParam' - $ref: '#/parameters/variableCategoryNameParam' - $ref: '#/parameters/sourceNameParam' - $ref: '#/parameters/valueParam' - $ref: '#/parameters/unitNameParam' - $ref: '#/parameters/earliestMeasurementTimeParam' - $ref: '#/parameters/latestMeasurementTimeParam' - $ref: '#/parameters/createdAtParam' - description: Measurement id in: query name: id required: false type: integer - $ref: '#/parameters/groupingWidthParam' - $ref: '#/parameters/groupingTimezoneParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/doNotProcessParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/doNotConvertParam' - $ref: '#/parameters/minMaxFilterParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/MeasurementArray' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - readmeasurements summary: Get measurements for this user tags: - measurements /v3/measurements/delete: delete: description: Delete a previously submitted measurement operationId: deleteMeasurement parameters: - description: The startTime and variableId of the measurement to be deleted. in: body name: body required: true schema: $ref: '#/definitions/MeasurementDelete' produces: - application/json responses: '204': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - writemeasurements summary: Delete a measurement tags: - measurements /v3/measurements/post: post: description: >- You can submit or update multiple measurements in a "measurements" sub-array. If the variable these measurements correspond to does not already exist in the database, it will be automatically added. operationId: postMeasurements parameters: - $ref: '#/parameters/userIdParam' - description: >- An array of measurement sets containing measurement items you want to insert. in: body name: body required: true schema: items: $ref: '#/definitions/MeasurementSet' type: array produces: - application/json responses: '201': description: Successful operation schema: $ref: '#/definitions/PostMeasurementsResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - writemeasurements summary: Post a new set or update existing measurements to the database tags: - measurements /v3/measurements/update: post: description: Delete a previously submitted measurement parameters: - description: >- The id as well as the new startTime, note, and/or value of the measurement to be updated in: body name: body required: true schema: $ref: '#/definitions/MeasurementUpdate' produces: - application/json responses: '201': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Update a measurement tags: - measurements /v3/notificationPreferences: get: description: Get NotificationPreferences operationId: getNotificationPreferences parameters: [] produces: - application/json responses: '200': description: Successful operation '401': description: Not authenticated '404': description: Not found '500': description: Internal server error summary: Get NotificationPreferences tags: - notifications /v3/oauth2/authorize: get: description: >- You can implement OAuth2 authentication to your application using our **OAuth2** endpoints. You need to redirect users to `/api/v3/oauth2/authorize` endpoint to get an authorization code and include the parameters below. This page will ask the user if they want to allow a client's application to submit or obtain data from their QM account. It will redirect the user to the url provided by the client application with the code as a query parameter or error in case of an error. See the /api/v2/oauth/access_token endpoint for the next steps. operationId: getOauthAuthorizationCode parameters: - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/clientSecretParam' - $ref: '#/parameters/responseTypeParam' - $ref: '#/parameters/scopeParam' - $ref: '#/parameters/redirectUriParam' - $ref: '#/parameters/stateParam' produces: - application/json responses: '200': description: Successful Operation '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Request Authorization Code tags: - authentication /v3/oauth2/token: get: description: >- Client provides authorization token obtained from /api/v3/oauth2/authorize to this endpoint and receives an access token. Access token can then be used to query API endpoints. ### Request Access Token After user approves your access to the given scope form the https:/app.quantimo.do/v2/oauth2/authorize endpoint, you'll receive an authorization code to request an access token. This time make a `POST` request to `/api/v2/oauth/access_token` with parameters including: * `grant_type` Can be `authorization_code` or `refresh_token` since we are getting the `access_token` for the first time we don't have a `refresh_token` so this must be `authorization_code`. * `code` Authorization code you received with the previous request. * `redirect_uri` Your application's redirect url. ### Refreshing Access Token Access tokens expire at some point, to continue using our api you need to refresh them with `refresh_token` you received along with the `access_token`. To do this make a `POST` request to `/api/v2/oauth/access_token` with correct parameters, which are: * `grant_type` This time grant type must be `refresh_token` since we have it. * `clientId` Your application's client id. * `client_secret` Your application's client secret. * `refresh_token` The refresh token you received with the `access_token`. Every request you make to this endpoint will give you a new refresh token and make the old one expired. So you can keep getting new access tokens with new refresh tokens. ### Using Access Token Currently we support 2 ways for this, you can't use both at the same time. * Adding access token to the request header as `Authorization: Bearer {access_token}` * Adding to the url as a query parameter `?access_token={access_token}` You can read more about OAuth2 from [here](http://oauth.net/2/) operationId: getAccessToken parameters: - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/clientSecretParam' - $ref: '#/parameters/grantTypeParam' - $ref: '#/parameters/codeParam' - $ref: '#/parameters/responseTypeParam' - $ref: '#/parameters/scopeParam' - $ref: '#/parameters/redirectUriParam' - $ref: '#/parameters/stateParam' produces: - application/json responses: '200': description: Successful Operation '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get a user access token tags: - authentication /v3/pairs: get: description: >- Pairs cause measurements with effect measurements grouped over the duration of action after the onset delay. operationId: getPairs parameters: - $ref: '#/parameters/effectUnitNameParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/causeVariableNameParam' - $ref: '#/parameters/causeUnitNameParam' - $ref: '#/parameters/onsetDelayParam' - $ref: '#/parameters/durationOfActionParam' - $ref: '#/parameters/effectVariableNameParam' - $ref: '#/parameters/earliestMeasurementTimeParam' - $ref: '#/parameters/latestMeasurementTimeParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/PairArray' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get pairs of measurements for correlational analysis tags: - measurements /v3/public/variables: get: description: >- This endpoint retrieves an array of all public variables. Public variables are things like foods, medications, symptoms, conditions, and anything not unique to a particular user. For instance, a telephone number or name would not be a public variable. operationId: getCommonVariables parameters: - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/variableCategoryNameParam' - description: >- Name of the variable. To get results matching a substring, add % as a wildcard as the first and/or last character of a query string parameter. In order to get variables that contain `Mood`, the following query should be used: ?variableName=%Mood% in: query name: name required: false type: string - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/sourceNameParam' - $ref: '#/parameters/earliestMeasurementTimeParam' - $ref: '#/parameters/latestMeasurementTimeParam' - $ref: '#/parameters/numberOfRawMeasurementsParam' - $ref: '#/parameters/lastSourceParam' - $ref: '#/parameters/limitParam' - description: Common variable id in: query name: id required: false type: integer - $ref: '#/parameters/sortParam' - $ref: '#/parameters/effectOrCauseParam' - $ref: '#/parameters/publicEffectOrCauseParam' - $ref: '#/parameters/exactMatchParam' - $ref: '#/parameters/manualTrackingParam' - $ref: '#/parameters/variableCategoryIdParam' - $ref: '#/parameters/includePrivateParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/searchPhraseParam' - $ref: '#/parameters/synonymsParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/CommonVariableArray' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get common variables with aggregated instead of user-specific data tags: - variables /v3/study/publish: post: description: Post Study Publish operationId: postStudyPublish parameters: [] produces: - application/json responses: '201': description: Successful operation schema: $ref: '#/definitions/PostStudyPublishResponse' '401': description: Not authenticated '404': description: Not found '500': description: Internal server error summary: Post Study Publish tags: - study /v3/trackingReminderNotifications: get: description: >- Specific tracking reminder notification instances that still need to be tracked. operationId: getTrackingReminderNotifications parameters: - $ref: '#/parameters/sortParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/createdAtParam' - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/variableCategoryNameParam' - $ref: '#/parameters/reminderTimeParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/onlyPastParam' - $ref: '#/parameters/includeDeletedParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/GetTrackingReminderNotificationsResponse' security: - access_token: [] - quantimodo_oauth2: - basic summary: Get specific tracking reminder notifications tags: - reminders post: description: 'Snooze, skip, or track a tracking reminder notification' operationId: postTrackingReminderNotifications parameters: - $ref: '#/parameters/userIdParam' - description: Id of the tracking reminder notification to be snoozed in: body name: body required: true schema: description: Array of TrackingReminderNotifications to take action on items: $ref: '#/definitions/TrackingReminderNotificationPost' type: array - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' produces: - application/json responses: '201': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: 'Snooze, skip, or track a tracking reminder notification' tags: - reminders /v3/trackingReminders: get: description: >- Users can be reminded to track certain variables at a specified frequency with a default value. operationId: getTrackingReminders parameters: - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/variableCategoryNameParam' - $ref: '#/parameters/createdAtParam' - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/appVersionParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/TrackingReminderArray' security: - access_token: [] - quantimodo_oauth2: - basic summary: Get repeating tracking reminder settings tags: - reminders post: description: >- This is to enable users to create reminders to track a variable with a default value at a specified frequency operationId: postTrackingReminders parameters: - description: TrackingReminder that should be stored in: body name: body required: true schema: $ref: '#/definitions/TrackingReminderArray' produces: - application/json responses: '201': description: Successful operation schema: $ref: '#/definitions/PostTrackingRemindersResponse' security: - access_token: [] - quantimodo_oauth2: - basic summary: Store a Tracking Reminder tags: - reminders /v3/trackingReminders/delete: delete: description: Delete previously created tracking reminder operationId: deleteTrackingReminder parameters: - $ref: '#/parameters/userIdParam' - description: Id of reminder to be deleted in: body name: body required: true schema: $ref: '#/definitions/TrackingReminderDelete' produces: - application/json responses: '204': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Delete tracking reminder tags: - reminders /v3/unitCategories: get: description: >- Get a list of the categories of measurement units such as 'Distance', 'Duration', 'Energy', 'Frequency', 'Miscellany', 'Pressure', 'Proportion', 'Rating', 'Temperature', 'Volume', and 'Weight'. operationId: getUnitCategories produces: - application/json responses: '200': description: Successful operation schema: items: $ref: '#/definitions/UnitCategory' type: array '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get unit categories tags: - units /v3/units: get: description: Get a list of the available measurement units operationId: getUnits produces: - application/json responses: '200': description: Successful operation schema: description: Array of units items: $ref: '#/definitions/Unit' type: array '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get units tags: - units /v3/user: get: description: >- Returns user info. If no userId is specified, returns info for currently authenticated user operationId: getUser parameters: - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/createdAtParam' - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/appVersionParam' - $ref: '#/parameters/clientUserIdParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/User' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Get user info tags: - user /v3/userSettings: post: description: Post UserSettings operationId: postUserSettings parameters: - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' produces: - application/json responses: '201': description: Successful operation schema: $ref: '#/definitions/PostUserSettingsResponse' '401': description: Not authenticated '404': description: Not found '500': description: Internal server error summary: Post UserSettings tags: - user /v3/userTags: post: description: >- This endpoint allows users to tag foods with their ingredients. This information will then be used to infer the user intake of the different ingredients by just entering the foods. The inferred intake levels will then be used to determine the effects of different nutrients on the user during analysis. operationId: postUserTags parameters: - $ref: '#/parameters/userIdParam' - description: Contains the new user tag data in: body name: body required: true schema: $ref: '#/definitions/UserTag' produces: - application/json responses: '201': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Post or update user tags or ingredients tags: - variables /v3/userTags/delete: delete: description: Delete previously created user tags or ingredients. operationId: deleteUserTag parameters: - $ref: '#/parameters/taggedVariableIdParam' - $ref: '#/parameters/tagVariableIdParam' produces: - application/json responses: '204': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Delete user tag or ingredient tags: - variables /v3/userVariables: get: description: >- Get variables for which the user has measurements. If the user has specified variable settings, these are provided instead of the common variable defaults. operationId: getUserVariables parameters: - description: >- Return highcharts configs that can be used if you have highcharts.js included on the page. This only works if the id or name query parameter is also provided. in: query name: includeCharts required: false type: boolean - $ref: '#/parameters/numberOfRawMeasurementsParam' - $ref: '#/parameters/userIdParam' - $ref: '#/parameters/variableCategoryNameParam' - description: >- Name of the variable. To get results matching a substring, add % as a wildcard as the first and/or last character of a query string parameter. In order to get variables that contain `Mood`, the following query should be used: ?variableName=%Mood% in: query name: name required: false type: string - $ref: '#/parameters/updatedAtParam' - $ref: '#/parameters/sourceNameParam' - $ref: '#/parameters/earliestMeasurementTimeParam' - $ref: '#/parameters/latestMeasurementTimeParam' - description: Common variable id in: query name: id required: false type: integer - $ref: '#/parameters/lastSourceParam' - $ref: '#/parameters/limitParam' - $ref: '#/parameters/offsetParam' - $ref: '#/parameters/sortParam' - $ref: '#/parameters/includePublicParam' - $ref: '#/parameters/manualTrackingParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' produces: - application/json responses: '200': description: Variables returned schema: items: $ref: '#/definitions/UserVariable' type: array '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: >- Get variables along with related user-specific analysis settings and statistics tags: - variables post: description: >- Users can change the parameters used in analysis of that variable such as the expected duration of action for a variable to have an effect, the estimated delay before the onset of action. In order to filter out erroneous data, they are able to set the maximum and minimum reasonable daily values for a variable. operationId: postUserVariables parameters: - $ref: '#/parameters/includePrivateParam' - $ref: '#/parameters/userVariablesParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/includePublicParam' - $ref: '#/parameters/searchPhraseParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/exactMatchParam' - $ref: '#/parameters/manualTrackingParam' - $ref: '#/parameters/variableCategoryNameParam' - $ref: '#/parameters/variableCategoryIdParam' - $ref: '#/parameters/synonymsParam' produces: - application/json responses: '201': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '400': description: The received JSON was invalid or malformed '401': description: Not Authenticated '404': description: Unknown target user ID security: - access_token: [] - quantimodo_oauth2: - basic summary: Update User Settings for a Variable tags: - variables /v3/userVariables/delete: delete: description: Users can delete all of their measurements for a variable operationId: deleteUserVariable parameters: - $ref: '#/parameters/variableIdBodyParam' produces: - application/json responses: '204': description: Successful operation '400': description: The received JSON was invalid or malformed '401': description: Not Authenticated '404': description: Unknown target user ID security: - access_token: [] - quantimodo_oauth2: - basic summary: Delete All Measurements For Variable tags: - variables /v3/userVariables/reset: post: description: Reset user settings for a variable to defaults operationId: resetUserVariableSettings parameters: - $ref: '#/parameters/variableIdBodyParam' produces: - application/json responses: '201': description: Successful operation '400': description: The received JSON was invalid or malformed '401': description: Not Authenticated '404': description: Unknown target user ID security: - access_token: [] - quantimodo_oauth2: - basic summary: Reset user settings for a variable to defaults tags: - variables /v3/variableCategories: get: description: >- The variable categories include Activity, Causes of Illness, Cognitive Performance, Conditions, Environment, Foods, Location, Miscellaneous, Mood, Nutrition, Physical Activity, Physique, Sleep, Social Interactions, Symptoms, Treatments, Vital Signs, and Work. operationId: getVariableCategories produces: - application/json responses: '200': description: Successful operation schema: items: $ref: '#/definitions/VariableCategory' type: array '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Variable categories tags: - variables /v3/votes: post: description: >- This is to enable users to indicate their opinion on the plausibility of a causal relationship between a treatment and outcome. We incorporates crowd-sourced plausibility estimations into our algorithm. This is done allowing user to indicate their view of the plausibility of each relationship with thumbs up/down buttons placed next to each prediction. operationId: postVote parameters: - $ref: '#/parameters/userIdParam' - description: 'Contains the cause variable, effect variable, and vote value.' in: body name: body required: true schema: $ref: '#/definitions/Vote' produces: - application/json responses: '201': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Post or update vote tags: - analytics /v3/votes/delete: delete: description: Delete previously posted vote operationId: deleteVote parameters: - $ref: '#/parameters/userIdParam' - description: >- The cause and effect variable names for the predictor vote to be deleted. in: body name: body required: true schema: $ref: '#/definitions/VoteDelete' produces: - application/json responses: '204': description: Successful Operation schema: $ref: '#/definitions/CommonResponse' '401': description: Not Authenticated security: - access_token: [] - quantimodo_oauth2: - basic summary: Delete vote tags: - analytics /v4/study: get: description: Get Study operationId: getStudy parameters: - $ref: '#/parameters/causeVariableNameParam' - $ref: '#/parameters/effectVariableNameParam' - $ref: '#/parameters/appNameParam' - $ref: '#/parameters/clientIdParam' - $ref: '#/parameters/includeChartsParam' produces: - application/json responses: '200': description: Successful operation schema: $ref: '#/definitions/GetStudyResponse' '401': description: Successful operation schema: $ref: '#/definitions/GetStudyResponse' '404': description: Not found '500': description: Internal server error summary: Get Study tags: - analytics produces: - application/json schemes: - https securityDefinitions: access_token: in: query name: access_token type: apiKey client_id: in: query name: clientId type: apiKey quantimodo_oauth2: authorizationUrl: 'https://app.quantimo.do/api/v2/oauth/authorize' flow: accessCode scopes: basic: 'Allows you to read user info (display name, email, etc).' readmeasurements: Allows one to read a user's data writemeasurements: Allows you to write user data tokenUrl: 'https://app.quantimo.do/api/v2/oauth/token' type: oauth2 swagger: '2.0' tags: - description: Identify the strongest predictors of a given outcome and generate studies externalDocs: description: Try it out url: 'https://app.quantimo.do/ionic/Modo/www/index.html#/app/predictor-search' name: analytics - description: Import data from third-party apps and devices like Fitbit and Mint. externalDocs: description: Import your data now url: 'https://app.quantimo.do/ionic/Modo/www/#/app/import' name: connectors - description: >- Measurements are any value that can be recorded like daily steps, a mood rating, or apples eaten. externalDocs: description: See it in action url: >- https://app.quantimo.do/ionic/Modo/www/#/app/history-all-category/Anything?accessToken=demo name: measurements - description: >- Users can be reminded to track certain variables at a specified frequency with a default value. externalDocs: description: See it in action url: >- https://app.quantimo.do/ionic/Modo/www/#/app/reminders-inbox?accessToken=demo name: reminders - description: Available units for measurements externalDocs: description: See it in action url: >- https://app.quantimo.do/ionic/Modo/www/#/app/measurement-search?accessToken=demo name: units - description: Get or update user info and settings externalDocs: description: See it in action url: 'https://app.quantimo.do/ionic/Modo/www/#/app/settings?accessToken=demo' name: user - description: >- Can be used for search autocomplete for data types like symptoms, foods and treatments and include statistics externalDocs: description: Search for a variable url: >- https://app.quantimo.do/ionic/Modo/www/#/app/reminder-search?accessToken=demo name: variables