Get Correlation Results

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

Request

HTTP Request

GET https://api.predicthq.com/v1/beam/analyses//correlate

Path Parameters

Parameter	Description

Query Parameters

Parameter	Description

Response

Response Fields

Field	Description

Example response

Below is an example response:

{
    "model_version": "1.1.0",
    "version": 0,
    "dates": [
        {
            "date": "2021-01-01",
            "actual_demand": 5893.0,
            "baseline_demand": 1642.8505673206673,
            "remainder": 4250.149432679333,
            "impact_significance": "MEDIUM",
            "impact_significance_score": 2,
            "features": {
                "phq_attendance_concerts": {
                    "count": 2,
                    "sum": 1300
                },
                "phq_attendance_performing_arts": {
                    "count": 1,
                    "sum": 500
                }
            },
            "phq_impact_sum": 0,
            "phq_spend_sum": 0,
            "phq_attendance_sum": 1800,
            "phq_rank_count": 0
        },
        {
            "date": "2021-01-02",
            "actual_demand": 4273.0,
            "baseline_demand": 4373.972146649381,
            "remainder": -100.9721466493811,
            "impact_significance": "NO_IMPACT",
            "impact_significance_score": 0,
            "features": {
                "phq_rank_health_warnings": {
                    "rank_levels": {
                        "5": 1
                    }
                }
            },
            "phq_impact_sum": 0,
            "phq_spend_sum": 0,
            "phq_attendance_sum": 0,
            "phq_rank_count": 1
        },
    ]
...
}

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())

Guides

Below are some guides relevant to this API:

• Beam Guides