Refresh an Analysis
Rerun the Beam correlation and analysis process.
Rerun the Beam correlation and analysis process.
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/authentication
Path parameters
analysis_idstringRequired
An existing Beam Analysis ID.
Responses
202
Successful Response
400
Analysis is already in the process of refreshing
403
Bearer token scope insufficient
404
Analysis not found
409
A data conflict has occurred due to the analysis being modified elsewhere. Please retry your call later.
422
Validation Error
application/json
post
/v1/beam/analyses/{analysis_id}/refreshPOST /v1/beam/analyses/{analysis_id}/refresh HTTP/1.1
Host: api.predicthq.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Examples
curl -X POST "https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID/refresh" \
-H "Accept: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN"import requests
response = requests.post(
url="https://api.predicthq.com/v1/beam/analyses/$ANALYSIS_ID/refresh",
headers={
"Authorization": "Bearer $ACCESS_TOKEN",
"Accept": "application/json"
}
)
print(response.status_code)OpenAPI Spec
The OpenAPI spec for Beam API can be found here.
Guides
Below are some guides relevant to this API:
Last updated
Was this helpful?