Search Analyses
Search for an existing Analysis.
GET https://api.predicthq.com/v1/beam/analyses
Parameter | Description |
|---|---|
status
string
optional | Comma separated list ( <status1>,<status2>) used to filter Beam analyses by their status.
Possible values:
E.g. ?status=draft,active |
readiness_status
string
optional | Comma separated list ( <readiness_status1>,<readiness_status2>) used to filter Beam analyses by their readiness status.
Possible values:
E.g. ?status=pending,ready |
sort
string
optional | Comma separated list ( <sort1>,<sort2>) used to sort Beam analyses.
Possible values:
E.g. ?sort=name,created |
limit
number
optional | Limits the length of the Beam analyses list returned. The default limit is 10.
E.g. ?limit=20 |
offset
number
optional | Specifies starting offset of the Beam analyses list returned. The default offset is 0.
E.g. ?offset=3 |
Field | Description |
|---|---|
count
number | Total number of results found. |
analyses
array | List of results where each item is an Analysis. |
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
}
},
"tz": "Pacific/Auckland",
"analysis_id": "analysis_id"
}
]
}
curl
python
curl -X GET https://api.predicthq.com/v1/beam/analyses?status=draft&sort=updated \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"
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())
Below are some guides relevant to this API:
Last modified 2mo ago