Skip to main content
GET
Get Test Run

Authorizations

X-API-Key
string
header
required

Authenticate every request by passing your API key in the X-API-Key header. To get your key, go to Dashboard → API Keys and create or copy your Production API key.

Path Parameters

jobId
string
required

The unique identifier of the simulation run to retrieve.

Query Parameters

batchId
string
required

The unique identifier of the batch run to which this simulation run belongs.

agentId
string
required

Unique identifier of the agent to which the batch run belongs.

Response

OK

List of items for the current page. Contains up to 'size' number of records.

batchId
string

The unique identifier of the batch run this simulation attempt belongs to.

Example:

"batch_s0OJu2JWR8R45Fai"

workspaceId
string

The unique identifier of the workspace under which this simulation attempt was created.

Example:

"org_V6eZ2zg8ziDx5pft"

agent
object

Agent assigned to handle all calls in this campaign. Contains the agent's ID, name, and current status. All contacts in the campaign's contact list will be called using this agent.

testCase
object
jobId
string

The unique identifier of this individual simulation attempt within the batch run.

Example:

"job_ksUu5yRHGTLLrLeM"

chatId
string

The unique identifier of the chat session generated during this simulation run.

Example:

"chat_IpELinkFvINQ1212"

createdDate
string<date-time>

The UTC timestamp indicating when this simulation run was initiated.

Example:

"2026-03-26T10:52:45.565Z"

completedDate
string<date-time>

The UTC timestamp indicating when this simulation run was completed.

Example:

"2026-03-26T10:54:45.565Z"

isSuccessful
boolean

Indicates whether the Agent met the success criteria during this simulation run.

Example:

true

remarks
string

A plain-language explanation of why the simulation run was evaluated as successful or failed, based on the success criteria.

Example:

"The Agent successfully maintained focus on the primary task of addressing the customer's order enquiry."

conversation
object[]

The full transcript of the conversation between the simulated user and the Agent during this simulation run.