Search Analyses

Search for an existing Analysis.

Search Analyses

get

Search for an existing Analysis.

Authorizations

BearerAuth

Query parameters

group_idstring[]Optional

An Analysis Group ID. Analyses that belong to this group will be returned.

Example: 3ED1zxXqAY

external_idstring[]Optional

Comma-separated list of External IDs.

Example: ["id1","id2"]

labelstring[]Optional

Comma-separated list of labels.

Example: ["label1","label2","label3"]

location.saved_location_idstring[]Optional

Comma-separated list of Saved Location IDs.

Example: ["id1","id2"]

limitintegerOptional

Limit the number of results.

Default: 10

offsetintegerOptional

Offset the results.

Default: 0

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/v1/beam/analyses

HTTPcURLJavaScriptPython

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

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

python

import requests

response = requests.get(
    url="https://api.predicthq.com/v1/beam/analyses",
    headers={
      "Authorization": "Bearer $ACCESS_TOKEN",
      "Accept": "application/json"
    },
    params={
        "status": "draft",
        "sort": "updated"
    }
)

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