Get an Analysis Group

Get an existing Analysis Group.

Get an Analysis Group

get

Get an existing Analysis Group.

Authorizations

BearerAuth

AuthorizationstringRequired

Enter your PredictHQ API key. The Bearer prefix is added automatically.

When calling the API directly, send: Authorization: Bearer <YOUR_API_KEY> as documented at https://docs.predicthq.com/api/overview/authenticating

Path parameters

group_idstringRequired

An Analysis Group ID. Analyses that belong to this group will be returned.

Example: 3ED1zxXqAY

Responses

200

Successful Response

application/json

403

Bearer token scope insufficient

404

Analysis Group not found

422

Validation Error

application/json

get

/v1/beam/analysis-groups/{group_id}

HTTPcURLJavaScriptPython

GET /v1/beam/analysis-groups/{group_id} HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.