Run Test
curl --request POST \
--url https://api.docketqa.com/test_group_run/trigger_run \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"test_blueprint_ids": [
123
]
}
'{
"message": "<string>",
"test_group_run": {
"id": 123,
"company_id": 123,
"name": "<string>",
"status": "<string>",
"test_runs": [
{
"id": 123,
"status": "<string>",
"test_blueprint_id": 123,
"test_group_run_id": 123,
"blueprint_metadata": {},
"results": [
{}
]
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
}Tests
Run Test
POST
/
test_group_run
/
trigger_run
Run Test
curl --request POST \
--url https://api.docketqa.com/test_group_run/trigger_run \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"test_blueprint_ids": [
123
]
}
'{
"message": "<string>",
"test_group_run": {
"id": 123,
"company_id": 123,
"name": "<string>",
"status": "<string>",
"test_runs": [
{
"id": 123,
"status": "<string>",
"test_blueprint_id": 123,
"test_group_run_id": 123,
"blueprint_metadata": {},
"results": [
{}
]
}
],
"created_at": "<string>",
"updated_at": "<string>"
}
}Trigger a test run for one or more test blueprints. Each test runs in its own remote screen session (browser or mobile device).
An array of test blueprint IDs to run. You can trigger multiple tests in a single request.
Example request body
{
"test_blueprint_ids": [181]
}
A confirmation message (e.g.
"Test group run triggered successfully").The created test group run object.
Show Properties
Show Properties
The unique ID of the test group run.
Your company ID.
Auto-generated name for the run (e.g.
"Manual Run 2025-07-03 01:38:03").The current status of the group run (e.g.
"running").Array of individual test run objects, one per blueprint ID.
Show Test run properties
Show Test run properties
The unique ID of the individual test run. Use this with the Get Test Run endpoint to poll for results.
The current status of this test run (e.g.
"running", "passed", "failed").The blueprint ID this run is executing.
The parent group run ID.
A snapshot of the test blueprint at the time the run was triggered.
Step-by-step results.
null while the test is still running.ISO 8601 timestamp of when the run was triggered.
ISO 8601 timestamp of the last status update.
Example response
{
"message": "Test group run triggered successfully",
"test_group_run": {
"company_id": 2,
"created_at": "2025-07-03T01:38:03.020496+00:00",
"id": 35,
"name": "Manual Run 2025-07-03 01:38:03",
"status": "running",
"test_runs": [
{
"blueprint_metadata": { ... },
"created_at": "2025-07-03T01:38:03.032648+00:00",
"id": 38,
"is_login_test_run": false,
"results": null,
"status": "running",
"test_blueprint_id": 180,
"test_group_run_id": 35,
"test_video_s3_key": null,
"updated_at": "2025-07-03T01:38:03.032653+00:00"
}
],
"updated_at": "2025-07-03T01:38:03.020501+00:00"
}
}
After triggering a run, use the
test_runs[].id value to poll the Get Test Run endpoint until the status changes from "running" to "passed" or "failed".⌘I