---
title: "Get Correlation Results"
method: GET
path: "/v1/beam/analyses/{analysis_id}/correlate"
tags: ["Analyses"]
---

# Get Correlation Results

`GET /v1/beam/analyses/{analysis_id}/correlate`

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

## Path parameters

- `analysis_id` string, required

## Query parameters

- `date.gt` string, date
- `date.gte` string, date
- `date.lt` string, date
- `date.lte` string, date
- `offset` integer
- `limit` integer

## Response `200`

Successful Response

- MultiDerivativeResponse — 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.
  - `model_version` string, required — The version identifier of the model used for the decomposition.
  - `version` integer, required — The version number of the correlation data.
  - `count` integer, required — Total number of correlation result records.
  - `dates` DemandDerivativeResponse[], required — The list of correlation results per date.
    - `date` string, required — The date of the Beam decomposition.
    - `baseline_demand` number — The expected demand for a given date.
    - `remainder` number — The difference between the actual_demand and the baseline_demand for a given date. This value may be positive or negative.
    - `actual_demand` number — The actual demand for a given date.
    - `impact_significance` 'NO_IMPACT' | 'WEAK' | 'MEDIUM' | 'SIGNIFICANT', required — Enum specifying how unusual the remainder is for a given date.
    - `impact_significance_score` 0 | 1 | 2 | 3 — Number specifying how unusual the remainder is for a given date. This value maps to `impact_significance`.
    - `features` object — A json object containing all non-zero features for a given date.
    - `phq_impact_sum` integer — The sum of all phq_impact features for a given date.
    - `phq_spend_sum` integer — The sum of all phq_spend features for a given date.
    - `phq_attendance_sum` integer — The sum of all phq_attendance features for a given date.
    - `phq_rank_count` integer — The sum of all phq_rank features for a given date.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Bearer token scope insufficient
- `404` — Analysis or Derivative not found
- `500` — Internal inconsistency detected. Please refresh the analysis

---

[API](https://skmtc.dev/predicthq/apis/predicthq-events-api.md) · [All operations](https://skmtc.dev/predicthq/apis/predicthq-events-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/predicthq/predicthq-events-api/revisions/66cd8ff349dd/schema)