Sign in

v1

latestOpenAPI 3.1.02026-07-2342137210.8 KB
Analyses

Get Correlation Results

Retrieve results of the correlation of our event data with your transactional demand data.

get/v1/beam/analyses/{analysis_id}/correlate

Path parameters

analysis_idstring required

An existing Beam Analysis ID.

Query parameters

date.gtstring date

Filters results after the specified date (exclusive).

date.gtestring date

Filters results on or after the specified date.

date.ltstring date

Filters results before the specified date (exclusive).

date.ltestring date

Filters results on or before the specified date.

offsetinteger

Zero-based index of the first result to return.

limitinteger

Limit the number of results.

Response

Successful Response

model_versionstring required

The version identifier of the model used for the decomposition.

versioninteger required

The version number of the correlation data.

countinteger required

Total number of correlation result records.