Skip to main content
GET
/
api
/
v1
/
templates
/
{template_id}
/
analysis
/
status
Check analysis status
curl --request GET \
  --url https://api.example.com/api/v1/templates/{template_id}/analysis/status \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "progress": 0,
  "current_step": "<string>",
  "message": "<string>",
  "steps": [
    {}
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "estimated_completion_at": "2023-11-07T05:31:56Z",
  "elapsed_time": 123,
  "error": {}
}

Authorizations

​
X-API-Key
string
header
required

Production API key. Development/test deployments may also allow X-Org-Name.

Path Parameters

​
template_id
string
required

Query Parameters

​
analysis_id
string | null

Specific analysis ID (defaults to latest)

Response

Successful Response

Analysis status response.

​
status
string
required
​
progress
integer
default:0
Required range: 0 <= x <= 100
​
current_step
string | null
​
message
string | null
​
steps
Steps · object[] | null
​
started_at
string<date-time> | null
​
estimated_completion_at
string<date-time> | null
​
elapsed_time
number | null
​
error
Error · object | null