Get an Analysis

Get an existing Analysis.

Get an Analysis

get

Get an existing Analysis.

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

analysis_idstringRequired

An existing Beam Analysis ID.

Responses

200

Successful Response

application/json

400

Analysis is not ready

403

Bearer token scope insufficient

404

Analysis not found

422

Validation Error

application/json

get

/v1/beam/analyses/{analysis_id}

HTTPcURLJavaScriptPython

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

{
  "name": "Analysis 1",
  "create_dt": "2023-03-01T23:03:19.403859+00:00",
  "update_dt": "2023-03-01T23:49:39.464011+00:00",
  "processed_dt": "2023-03-01T23:43:52.253150+00:00",
  "user_id": null,
  "external_id": "id1",
  "label": [
    "label1",
    "label2",
    "label3"
  ],
  "location": {
    "geopoint": {
      "lat": "-36.849761",
      "lon": "174.7628903"
    },
    "radius": 1.2,
    "unit": "km"
  },
  "demand_type": {
    "interval": "week",
    "week_start_day": "monday",
    "industry": "restaurants"
  },
  "rank": {
    "type": "phq",
    "levels": {
      "phq": {
        "min": 51
      }
    }
  },
  "tz": "UTC",
  "readiness_status": "ready",
  "readiness_checks": {
    "date_range": {
      "start": "2017-01-01",
      "end": "2017-12-31"
    },
    "validation_response": {
      "missing_data_percentage": 0,
      "consecutive_nan": 0
    }
  },
  "processing_completed": {
    "correlation": true,
    "feature_importance": true
  },
  "access_type": "full",
  "status": "draft"
}

Examples

curl

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

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

Guides

Below are some guides relevant to this API:

• Beam Guides