Get batch test

Read a batch test with its counts and the status of every test run.

GEThttps://api.tried.com.au/get-batch-test/{id}

Returns one batch test with its runs in the order they execute. Run transcripts are left out; read them with Get test run.

Request#

Field	Type	Required	Description
`id`	string	Yes	Path parameter. The `batch_test_id`.

Example request#

curl https://api.tried.com.au/get-batch-test/batch_test_2c3d4e5f6a7b8c9d0e1f2a3b \
  -H "Authorization: Bearer $TRIED_API_KEY"

const id = "batch_test_2c3d4e5f6a7b8c9d0e1f2a3b";
const res = await fetch(`https://api.tried.com.au/get-batch-test/${id}`, {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const batchTest = await res.json();

import os, requests

batch_test_id = "batch_test_2c3d4e5f6a7b8c9d0e1f2a3b"
res = requests.get(
    f"https://api.tried.com.au/get-batch-test/{batch_test_id}",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
batch_test = res.json()

Response#

200 OK

{
  "batch_test_id": "batch_test_2c3d4e5f6a7b8c9d0e1f2a3b",
  "agent_id": "agent_3e4f5a6b7c8d9e0f1a2b3c4d",
  "status": "in_progress",
  "total_count": 2,
  "pass_count": 1,
  "fail_count": 0,
  "error_count": 0,
  "created_timestamp": 1760850000000,
  "completed_timestamp": null,
  "test_runs": [
    {
      "test_run_id": "test_run_5e6f7a8b9c0d1e2f3a4b5c6d",
      "batch_test_id": "batch_test_2c3d4e5f6a7b8c9d0e1f2a3b",
      "test_case_definition_id": "test_case_8f7e6d5c4b3a29180f1e2d3c",
      "test_case_name": "Reschedule appointment",
      "agent_id": "agent_3e4f5a6b7c8d9e0f1a2b3c4d",
      "status": "pass",
      "explanation": "The agent offered Thursday 10am and confirmed the change.",
      "error": null,
      "duration_ms": 41200,
      "created_timestamp": 1760850000000,
      "completed_timestamp": 1760850041200
    },
    {
      "test_run_id": "test_run_9d8c7b6a5f4e3d2c1b0a9f8e",
      "batch_test_id": "batch_test_2c3d4e5f6a7b8c9d0e1f2a3b",
      "test_case_definition_id": "test_case_1a2b3c4d5e6f708192a3b4c5",
      "test_case_name": "Cancel and rebook",
      "agent_id": "agent_3e4f5a6b7c8d9e0f1a2b3c4d",
      "status": "running",
      "explanation": null,
      "error": null,
      "duration_ms": null,
      "created_timestamp": 1760850000000,
      "completed_timestamp": null
    }
  ]
}

The batch fields are described in Create batch test, and the run fields in Get test run.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `agents` scope.
`404`	`Batch test <id> not found`.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Same path and method as Retell. The response shape differs: Tried returns batch_test_id and a test_runs array.