Get Correlation Results

Get Correlation Results

get

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

Authorizations

BearerAuth

Path parameters

analysis_idstringRequired

An existing Beam Analysis ID.

Query parameters

date.gtstring · dateOptional

Filters results after the specified date (exclusive).

Example: 2017-01-01

date.gtestring · dateOptional

Filters results on or after the specified date.

Example: 2017-01-01

date.ltstring · dateOptional

Filters results before the specified date (exclusive).

Example: 2025-01-07

date.ltestring · dateOptional

Filters results on or before the specified date.

Example: 2025-01-07

offsetintegerOptional

Offset the results.

Default: 0

limitintegerOptional

Limit the number of results.

Default: 10

Responses

200

Successful Response

application/json

400

Missing/invalid date parameters or Feature impact is outdated. Analysis needs to be refreshed

403

Bearer token scope insufficient

404

Analysis or Derivative not found

422

Validation Error

application/json

500

Internal inconsistency detected. Please refresh the analysis

get

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

HTTPcURLJavaScriptPython

GET /v1/beam/analyses/{analysis_id}/correlate HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "model_version": "text",
  "version": 1,
  "count": 1,
  "dates": [
    {
      "date": "2021-01-01",
      "baseline_demand": 1642.8505673206673,
      "remainder": 4250.149432679333,
      "actual_demand": 5893,
      "impact_significance": "NO_IMPACT",
      "impact_significance_score": 0
    }
  ]
}

Examples

curl

curl -X GET "https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID/correlate?date.gte=2022-01-01&date.lte=2022-12-31" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

python

import requests

response = requests.get(
    url="https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID/correlate",
    headers={
      "Authorization": "Bearer $ACCESS_TOKEN",
      "Accept": "application/json"
    },
    params={
        "date.gte": "2022-01-01",
        "date.lte": "2022-12-31"
    }
)

print(response.json())

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

Guides

Below are some guides relevant to this API:

• Beam Guides