Search Analysis Groups

Search for an existing Analysis Group.

Search Analysis Groups

get

Returns a paginated list of your Analysis Groups. Supports filtering by status, readiness_status, industry, interval, and date range.

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

updated.gtstring · dateOptional

Filters analysis groups updated after the specified date (exclusive).

Example: 2017-01-01

updated.gtestring · dateOptional

Filters analysis groups updated on or after the specified date.

Example: 2017-01-01

updated.ltstring · dateOptional

Filters analysis groups updated before the specified date (exclusive).

Example: 2025-01-07

updated.ltestring · dateOptional

Filters analysis groups updated on or before the specified date.

Example: 2025-01-07

qstring · max: 500Optional

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

countintegerRequired

Total number of analysis groups matching the query.

400

Bad Request

application/json

401

Unauthorized

application/json

403

Bearer token scope insufficient

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 $API_TOKEN"

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.