API Reference

Get pairs of measurements for correlational analysis

Pairs cause measurements with effect measurements grouped over the duration of action after the onset delay.

Log in to see full request history
Query Params
string

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

string

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

integer

Variable id of the hypothetical predictor variable. Ex: 1398

integer

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

string

Name of the hypothetical predictor variable. Ex: Sleep Duration

string

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

string

Name for the unit effect measurements to be returned in

number

User's id

string

Name for the unit cause measurements to be returned in

string

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.

string

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

string

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.

string

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.

integer
Defaults to 100

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

integer
≥ 0

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.

string

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

Responses

401

Not Authenticated

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json