v1

latestOpenAPI 3.0.1GNU General Public License v3 (GPL-3)2026-07-145265194.5 KB
analytics

Get correlation explanations

Get explanations of correlations based on data from a single user.

get/v3/correlations/explanations

Query parameters

causeVariableNamestring

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

effectVariableNamestring

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

causeVariableIdinteger

Variable id of the hypothetical predictor variable. Ex: 1398

effectVariableIdinteger

Variable id of the outcome variable of interest. Ex: 1398

predictorVariableNamestring

Name of the hypothetical predictor variable. Ex: Sleep Duration

outcomeVariableNamestring

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

Response

Successful Operation

averageDailyHighCausenumber double

Ex: 4.19

averageDailyLowCausenumber double

Ex: 1.97

averageEffectnumber double

Ex: 3.0791054117396

averageEffectFollowingHighCausenumber double

Ex: 3.55

averageEffectFollowingLowCausenumber double

Ex: 2.65

averageForwardPearsonCorrelationOverOnsetDelaysnumber double

Ex: 0.396

averageReversePearsonCorrelationOverOnsetDelaysnumber double

Ex: 0.453667

averageVotenumber

Ex: 0.9855

causeChangesinteger

Ex: 164

causeUserVariableShareUserMeasurementsinteger

Ex: 1

causeVariableCategoryIdinteger

Ex: 6

causeVariableCategoryNamestring

Ex: Sleep

causeVariableCombinationOperationstring

Ex: MEAN

causeVariableUnitAbbreviatedNamestring

Ex: /5

causeVariableIdinteger

Ex: 1448

causeVariableMostCommonConnectorIdinteger

Ex: 6

causeVariableNamestring required

Ex: Sleep Quality

confidenceIntervalnumber double

Ex: 0.14344467795996

confidenceLevelstring

Ex: high

correlationCoefficientnumber double

Ex: 0.538

correlationIsContradictoryToOptimalValuesboolean

Ex: false

createdAtstring

Ex: 2016-12-28 20:47:30 UTC ISO 8601 YYYY-MM-DDThh:mm:ss

criticalTValuenumber double

Calculated Statistic: Ex: 1.646

directionstring

Ex: higher

durationOfActioninteger

User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. Unit: Seconds

durationOfActionInHoursnumber float

User-Defined Variable Setting: The amount of time over which a predictor/stimulus event can exert an observable influence on an outcome variable value. For instance, aspirin (stimulus/predictor) typically decreases headache severity for approximately four hours (duration of action) following the onset delay. Unit: Hours

degreesOfFreedominteger

Ex: 200

effectNumberOfProcessedDailyMeasurementsinteger

Ex: 145

errorstring

Ex: optimalPearsonProduct is not defined

effectChangesinteger

Ex: 193

effectSizestring

Ex: moderately positive

effectUnitstring

Ex: /5

effectUserVariableShareUserMeasurementsinteger

Ex: 1

effectVariableCategoryIdinteger

Ex: 1

effectVariableCategoryNamestring

Ex: Emotions

effectVariableCombinationOperationstring

Ex: MEAN

effectVariableCommonAliasstring

Ex: Mood_(psychology)

effectVariableUnitAbbreviatedNamestring

Ex: /5

effectVariableUnitIdinteger

Ex: 10

effectVariableUnitNamestring

Ex: 1 to 5 Rating

effectVariableIdinteger

Ex: 1398

effectVariableMostCommonConnectorIdinteger

Ex: 10

effectVariableNamestring required

Ex: Overall Mood

experimentEndTimestring

Ex: 2014-07-30 12:50:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss

experimentStartTimestring

Ex: 2012-05-06 21:15:00 UTC ISO 8601 YYYY-MM-DDThh:mm:ss

forwardSpearmanCorrelationCoefficientnumber double

Ex: 0.528359

numberOfPairsinteger

Ex: 298

onsetDelayinteger

Ex: 0

onsetDelayInHoursnumber float

Ex: 0

onsetDelayWithStrongestPearsonCorrelationinteger

Ex: -86400

onsetDelayWithStrongestPearsonCorrelationInHoursnumber float

Ex: -24

optimalPearsonProductnumber double

Ex: 0.68582816186982

outcomeFillingValueinteger

User-Defined Variable Setting: Ex: -1. Unit: User-specified or common.

outcomeMaximumAllowedValuenumber double

User-Defined Variable Setting: Ex: 23. Unit: User-specified or common.

outcomeMinimumAllowedValuenumber double

User-Defined Variable Setting: Ex: 0.1. Unit: User-specified or common.

pearsonCorrelationWithNoOnsetDelaynumber double

Ex: 0.477

predictivePearsonCorrelationnumber double

Ex: 0.538

predictivePearsonCorrelationCoefficientnumber double

Ex: 0.538

predictorDataSourcesstring

Ex: RescueTime

predictorFillingValueinteger

Ex: -1. Unit: User-specified or common.

predictorMaximumAllowedValuenumber double

Ex: 200. Unit: User-specified or common.

predictorMinimumAllowedValuenumber double

Ex: 30. Unit: User-specified or common.

predictsHighEffectChangeinteger

Ex: 17. Unit: User-specified or common.

predictsLowEffectChangeinteger

Ex: -11. Unit: User-specified or common.

pValuenumber double

Ex: 0.39628900511586

qmScorenumber double

Ex: 0.528

reversePearsonCorrelationCoefficientnumber double

Ex: 0.01377184270977

shareUserMeasurementsboolean

Would you like to make this study publicly visible?

sharingDescriptionstring

Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood

sharingTitlestring

Ex: N1 Study: Sleep Quality Predicts Higher Overall Mood

significantDifferenceboolean

Ex: 1

statisticalSignificancenumber double

Ex: 0.9813

strengthLevelstring

Ex: moderate

strongestPearsonCorrelationCoefficientnumber double

Ex: 0.613

tValuenumber double

Ex: 9.6986079652717

updatedAtstring

Ex: 2017-05-06 15:40:38 UTC ISO 8601 YYYY-MM-DDThh:mm:ss

userIdinteger

Ex: 230

userVoteinteger

Ex: 1

valuePredictingHighOutcomenumber double

Ex: 4.14

valuePredictingLowOutcomenumber double

Ex: 3.03

outcomeDataSourcesstring

Sources used to collect data for the outcome variable

principalInvestigatorstring

Mike Sinn

reverseCorrelationnumber

Correlation when cause and effect are reversed. For any causal relationship, the forward correlation should exceed the reverse correlation.

averagePearsonCorrelationCoefficientOverOnsetDelaysnumber float

Ex:

causeNumberOfRawMeasurementsinteger

Ex: 14764

correlationsOverDurationsOfActionChartConfigobject

Highchart config illustrating correlations calculated with various duration of action hyper-parameters

correlationsOverOnsetDelaysChartConfigobject

Highchart config illustrating correlations calculated with various onset delay hyper-parameters

numberOfUsersnumber

Ex: 1

rawCauseMeasurementSignificancenumber double

Ex: 1

rawEffectMeasurementSignificancenumber double

Ex: 1

reversePairsCountstring

Ex: 1

voteStatisticalSignificanceinteger

Ex: 1

aggregateQMScorenumber double

Ex: 0.011598441286655

forwardPearsonCorrelationCoefficientnumber double

Ex: 0.0333

numberOfCorrelationsinteger

Ex: 6

votenumber

Ex: 1 or 0