Search Analysis Groups

Search for an existing Analysis Group.

Search Analysis Groups

get

Search for 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

Query parameters

qstringOptional

Query string to be matched against Group name.

Example: MyAnalysisGroup

offsetintegerOptional

Offset the results.

Default: 0

limitintegerOptional

Limit the number of results.

Default: 10

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/beam/analysis-groups

HTTPcURLJavaScriptPython

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

{
  "count": 1,
  "groups": [
    {
      "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?status=active&sort=updated" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.