Delete an Analysis

Delete an existing Analysis.

Delete an Analysis

delete

Delete an existing Analysis. The Analysis will no longer appear in default search results, but can still be retrieved by filtering with status=deleted. Any Analysis Groups containing this Analysis will be automatically refreshed.

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

202

Successful Response

No content

400

Bad Request

application/json

401

Unauthorized

application/json

403

Bearer token scope insufficient

application/json

404

Analysis not found

application/json

409

Data conflict

application/json

delete/v1/beam/analyses/{analysis_id}

HTTPcURLJavaScriptPython

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

No content

Examples

curl

curl -X DELETE "https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID" \
     -H "Authorization: Bearer $API_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