Get Run Status

Get the current status of a simulation run.

GET /api/v1/simulation/runs/{run_id}/status

Get Run Status

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/simulation/runs/{run_id}/status \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/simulation/runs/{run_id}/status"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/simulation/runs/{run_id}/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "status": "<string>",
  "object": "simulation_run_status",
  "total_tests": 0,
  "completed_tests": 0,
  "progress_percentage": 0
}

Authorizations

X-API-Key · string · header · required

Path Parameters

run_id · string · required

Response

200 - application/json

OK

Response schema for simulation run status polling.

status · string · required

object · string · default: simulation_run_status

total_tests · integer · default: 0

completed_tests · integer · default: 0

progress_percentage · number · default: 0