Get Feature Importance for an Analysis Group

Get Feature Importance data for an Analysis Group.

This endpoint provides Feature Importance results aggregated across the Analyses in an existing Analysis Group, and returns a list of feature groups with associated Features API features and group p-values.

Get Feature Importance for an Analysis Group

get

Get Feature Importance data for an 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

400

Feature importance data is not ready or not found

403

Bearer token scope insufficient

404

Analysis Group not found

422

Validation Error

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "feature_importance": [
    {
      "feature_group": [
        "severe-weather",
        "concerts"
      ],
      "features": [
        "phq_attendance_concerts"
      ],
      "p_value": 0.312,
      "important": true
    }
  ]
}

Examples

curl

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

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.