Skip to main content
GET
/
ai
/
assistants
/
tests
/
test-suites
/
{suite_name}
/
runs
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const paginatedTestRunList = await client.ai.assistants.tests.testSuites.runs.list('suite_name');

console.log(paginatedTestRunList.data);
{
  "meta": {
    "total_pages": 123,
    "total_results": 123,
    "page_number": 123,
    "page_size": 123
  },
  "data": [
    {
      "run_id": "987fcdeb-51a2-43d1-b456-426614174000",
      "test_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "pending",
      "triggered_by": "cron",
      "created_at": "2024-01-15T10:30:00Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "logs": "<string>",
      "conversation_id": "<string>",
      "conversation_insights_id": "<string>",
      "test_suite_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updated_at": "2023-11-07T05:31:56Z",
      "detail_status": [
        {
          "name": "<string>",
          "status": "pending"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

suite_name
string
required

Query Parameters

status
string

Filter runs by execution status (pending, running, completed, failed, timeout) Filter runs by execution status (pending, running, completed, failed, timeout)

test_suite_run_id
string

Filter runs by specific suite execution batch ID Filter runs by specific suite execution batch ID

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

Returns paginated list of test runs within the specified suite

Paginated list of test runs with metadata.

Returns test run execution results with pagination support for handling large numbers of test executions.

meta
Meta · object
required

Pagination metadata including total counts and current page info.

data
TestRunResponse · object[]
required

Array of test run objects for the current page.