Get an Analysis Group

Get an existing Analysis Group.

Request

HTTP Request

GET https://api.predicthq.com/v1/beam/analysis-groups/$group_id

Path Parameters

Parameter	Description
group_id	An existing Beam Analysis Group ID.

Response

Response Fields

Field	Description
name string	Name of the Analysis Group. E.g. My Analysis Group 1
create_dt string	The creation date time for the Analysis Group in ISO 8601 format. E.g. 2022-04-26T11:46:24+00:00
update_dt string	The last update date time for the Analysis Group in ISO 8601 format. E.g. 2022-04-26T11:46:24+00:00
processed_dt string	The date time the Analysis Group was last processed in ISO 8601 format. E.g. 2022-04-26T11:46:25+00:00
user_id string	The ID of the user who created the Analysis Group. This is present for Analysis Groups created in Control Center. For Analysis Groups created via the API this field will not be populated. E.g. hjqkKozgS8mm
analysis_ids string[]	A list of strings containing the IDs of Analyses included in this Group. E.g. { "analysis_ids": [ "0GTpLZ522Bc", "6OK88wZ_Pv0" ] }
processing_completed object	The value of this field determines whether or not the aggregated Feature Importance is ready to be viewed for an Analysis Group. It also includes an optional list of Analyses which were excluded from processing for various reasons. E.g. { "processing_completed": { "feature_importance": true, "excluded_analyses": [ { "analysis_id": "0GTpLZ522Bc", "reason": "analysis_failed" }, { "analysis_id": "6OK88wZ_Pv0", "reason": "analysis_deleted" } ] } } Possible values for reason: analysis_not_ready analysis_feature_importance_incomplete analysis_failed analysis_deleted analysis_not_found
readiness_status string	The value of this field determines whether or not the Analysis Group has finished processing. When you create an Analysis Group, modify it or any of the Analyses that are part of it, or refresh it, the readiness_status will be set to pending until processing has completed. Possible values: pending failed ready E.g. ready
status string	Status of the Analysis Group. Possible values: active deleted E.g. active
demand_type object	Indicates the demand type of the Analyses within the group. Fields: interval - day or week week_start_day - e.g. sunday, monday etc. Only displayed for weekly Analysis Groups

Example response

Below is an example response:

{
    "name": "My Analysis Group 1",
    "create_dt": "2024-02-23T01:37:34.784468+00:00",
    "update_dt": "2024-02-23T01:37:34.784468+00:00",
    "analysis_ids": [
        "0GTpLZ522Bc",
        "6OK88wZ_Pv0"
    ],
    "processing_completed": {
        "feature_importance": true,
        "excluded_analyses": [
            {
                "analysis_id": "0GTpLZ522Bc",
                "reason": "analysis_failed"
            },
            {
                "analysis_id": "6OK88wZ_Pv0",
                "reason": "analysis_failed"
            }
        ]
    },
    "status": "active",
    "readiness_status": "failed",
    "user_id": "MT_KIk17j-w",
    "demand_type": {
        "interval": "day"
    },
    "processed_dt": "2024-02-23T01:37:37.181042+00:00"
}

Examples

curl

curl -X GET "https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

python

import requests

response = requests.get(
    url="https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID",
    headers={
      "Authorization": "Bearer $ACCESS_TOKEN",
      "Accept": "application/json"
    }
)

print(response.json())