Delete an Analysis Group

Delete an existing Analysis Group.

Delete an Analysis Group

delete

Delete an existing Analysis Group.

Authorizations

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

403

Bearer token scope insufficient

404

Analysis Group not found

409

A data conflict has occurred due to the analysis group being modified elsewhere. Please retry your call later.

422

Validation Error

application/json

delete

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

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

No content

Examples

curl -X DELETE "https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID" \
     -H "Authorization: Bearer $ACCESS_TOKEN"

import requests

response = requests.delete(
    url="https://api.predicthq.com/v1/beam/analysis-groups/$GROUP_ID",
    headers={
      "Authorization": "Bearer $ACCESS_TOKEN"
    }
)

print(response.status_code)

OpenAPI Spec

The OpenAPI spec for Beam API can be found here.

PreviousPartially Update an Analysis Group NextSearch Analysis Groups

Last updated 1 month ago

Was this helpful?

Good night