Test Runs

Test runs represent the execution of tests in Magic Inspector. Through these endpoints, you can monitor the status of your test executions.

The run model

The run model contains information about test executions, including their current status and timing information.

Properties

Name
id
Type
string
Description
Unique identifier for the run.
Name
status
Type
string
Description
Current status of the run. Can be one of: queued, running, success, failed, idle, canceled, resumed

GET/v1/projects/{projectId}/runs/{runId}/status

Get run status

This endpoint allows you to check the current status of a specific test run.

Required parameters

Name
projectId
Type
string
Description
The ID of the project containing the run.
Name
runId
Type
string
Description
The ID of the run to check.

Required headers

Name
X-Api-Key
Type
string
Description
Your project API key for authentication.

Request

GET

/v1/projects/proj_123/runs/run_123/status

curl https://api.magicinspector.com/v1/projects/proj_123/runs/run_123/status \
  -H "X-Api-Key: {your-api-key}"

Response

{
  "data": {
    "id": "run_123",
    "status": "running"
  },
  "links": {
    "self": "https://api.magicinspector.com/v1/projects/proj_123/runs/run_123/status"
  }
}