Get Correlation Results
Retrieve results of the correlation of our event data with your transactional demand data.
Last updated
Was this helpful?
Retrieve results of the correlation of our event data with your transactional demand data.
Last updated
Was this helpful?
analysis_id
An existing Beam Analysis ID.
date.*
string
required
Filters out correlation data not included in the date range. The date
parameter must have an upper (lt
or lte
) and lower (gt
or gte
) bound suffix.
The accepted format for this parameter is YYYY-MM-DD
E.g. ?date.gt=2017-01-01&date.lte=2017-12-01
limit
number
optional
Limits the length of the Beam decomposition list returned. The default limit
is 30
.
E.g. ?limit=20
offset
number
optional
Specifies starting offset of the Beam decomposition list returned. The default offset
is 0
.
E.g. ?offset=3
Please note we have deprecated some fields in this endpoint. The deprecated fields are not intended to be used to get current feature values for use in forecasting or other use-cases. They're a snapshot of some of the data from the time the correlation process was run, so for any other purposes are immediately out-of-date. Please fetch the latest data from Features API instead.
count
number
The number of Beam decomposition dates returned.
dates
array
An array of Beam decomposition dates.
dates.date
date
The date of the Beam decomposition.
dates.actual_demand
number
The actual demand for a given date.
dates.baseline_demand
number
The expected demand for a given date.
dates.remainder
number
The difference between the actual_demand
and the baseline_demand
for a given date. This value may be positive or negative.
dates.impact_significance
string
Enum specifying how unusual the remainder
is for a given date.
Possible values:
NO_IMPACT
WEAK
MEDIUM
SIGNIFICANT
dates.impact_significance_score
number
Number specifying how unusual the remainder
is for a given date. This value maps to impact_significance
.
Possible values:
0
1
2
3
A json object containing all non-zero features for a given date.
The number of events corresponding to this <feature>
for a given date.
The sum of the values of this <feature>
for a given date.
dates.phq_impact_sum
The sum of all phq_impact
features for a given date
dates.phq_spend_sum
The sum of all phq_spend
features for a given date
dates.phq_attendance_sum
The sum of all phq_attendance
features for a given date
dates.phq_rank_sum
The sum of all phq_rank
features for a given date
Below are some guides relevant to this API:
dates.features
object
Deprecated
dates.features.<feature>.count
number
Deprecated
dates.features.<feature>.sum
number
Deprecated
number Deprecated
number Deprecated
number Deprecated
number Deprecated