Refresh an Analysis Group

Re-run the Beam Analysis Group aggregation process.

Refresh an Analysis Group

post

Rerun the Beam Analysis Group aggregation process. The readiness_status will be set to pending until processing completes. Returns 400 if the Group is already being processed.

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

group_idstringRequired

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

Example: 3ED1zxXqAY

Responses

202

Successful Response

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Bearer token scope insufficient

application/json

404

Analysis Group not found

application/json

409

Data conflict

application/json

post/v1/beam/analysis-groups/{group_id}/refresh

HTTPcURLJavaScriptPython

POST /v1/beam/analysis-groups/{group_id}/refresh HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Examples

curl

curl -X POST "https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID/refresh" \
     -H "Accept: application/json" \
     -H "Authorization: Bearer $API_TOKEN"

python

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.