Create an Analysis Group

Creating an Analysis Group allows to aggregate Feature Importance for a number of Analyses

Request

HTTP Request

POST https://api.predicthq.com/v1/beam/analysis-groups

Request Headers

Header	Value
Content-Type	application/json

Request Body

Field	Description
name string required	Name of an analysis group. E.g. My Analysis Group 1
analysis_ids string[] required	The list of existing analysis ids to include in the group. E.g. "analysis_ids": [ "zRa_kk7MlAA", "3aR-gbJp98I", "JBb08XsZqAo", "q9iX2XqFBxM" ] Analyses can belong to multiple groups. Analyses must have the same demand type, i.e. the interval must match, and in case of weekly analyses week_start_day must also be consistent across all analyses in the group.

Response

Example response

Below is an example response:

{
    "group_id": "wyy0nguQHPs"
}

Examples

curl

curl -X POST https://api.predicthq.com/v1/beam/analysis-groups \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN" \
     --data @<(cat <<EOF
    {
        "name": "Analysis Group 1",
        "analysis_ids": [
            "zRa_kk7MlAA",
            "3aR-gbJp98I",
            "JBb08XsZqAo",
            "q9iX2XqFBxM"
        ]
    }
    EOF
    )

python

import requests

response = requests.post(
    url="https://api.predicthq.com/v1/beam/analysis-groups",
    headers={
        "Authorization": "Bearer $ACCESS_TOKEN",
        "Accept": "application/json"
    },
    json={
        "name": "Analysis Group 1",
        "analysis_ids": [
            "zRa_kk7MlAA",
            "3aR-gbJp98I",
            "JBb08XsZqAo",
            "q9iX2XqFBxM",
        ],
    }
)

print(response.json())

Best Practices

Please refer to this guide for the best practices on grouping analyses: https://www.predicthq.com/support/grouping-analyses-in-beam