Search Analyses

Search for an existing Analysis.

Request

HTTP Request

GET https://api.predicthq.com/v1/beam/analyses

Query Parameters

Parameter	Description

Response

Response Fields

Field	Description

Example response

Below is an example response:

{
    "count": 1,
    "analyses": [
        {
            "name": "Analysis 1",
            "location": {
                "geopoint": {
                    "lat": "-36.85088270000001",
                    "lon": "174.7644881"
                },
                "radius": 10,
                "unit": "km"
            },
            "rank": {
                "type": "phq",
                "levels": {
                    "phq": {
                        "min": 51
                    }
                }
            },
            "status": "draft",
            "create_dt": "2021-08-19T23:46:49.172401+00:00",
            "update_dt": "2021-08-20T00:20:19.770461+00:00",
            "user_id": "user_id",
            "access_type": "full",
            "processed_dt": "2021-08-19T23:50:53.456047+00:00",
            "readiness_status": "ready",
            "readiness_checks": {
                "date_range": {
                    "start": "2021-01-01",
                    "end": "2021-12-31"
                },
                "validation_response": {
                    "missing_data_percentage": 0.0,
                    "consecutive_nan": 0
                }
            },
            "demand_type": {
                "interval": "week",
                "week_start_day": "sunday"
            },
            "analysis_id": "analysis_id",
            "external_id": "external_id",
            "label": ["label1", "label2", "label3"]
        }
    ]
}

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())

Guides

Below are some guides relevant to this API:

• Beam Guides