Get Feature Importance

Get relevant ML features based on a Beam Analysis.

The easiest way to get these ML features from our Features API to be used in your models is by using the Beam analysis_id in your Features API request.

Get Feature Importance

get

This endpoint provides the relevant ML features (based on feature importance testing) that are shown to impact the demand for the Beam Analysis. These are the features you should take into your forecasting model to improve your model accuracy.

These values represent each group of features' statistical significance when it comes to impacting observable incremental/decremental changes in demand.

The easiest way to get these ML features from our Features API to be used in your models is by using the Beam analysis_id in your Features API request.

Authorizations

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

analysis_idstringRequired

An existing Beam Analysis ID.

Responses

200

Successful Response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Bearer token scope insufficient

application/json

404

Analysis not found or no feature importance data

application/json

get/v1/beam/analyses/{analysis_id}/feature-importance

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

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

Examples

curl

curl -X GET "https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID/feature-importance" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $API_TOKEN"

python

import requests

response = requests.get(
    url="https://api.predicthq.com/v1/beam/analyses/<analysis_id>/feature-importance",
    headers={
      "Authorization": "Bearer $API_TOKEN",
      "Accept": "application/json"
    }
)

print(response.json())

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

Guides

Below are some guides relevant to this API:

• Beam Guides