Skip to main content
GET
/
v1
/
simulation
/
plan
JavaScript
import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const simulationRunPlans = await client.simulationRunPlan.list();

console.log(simulationRunPlans.data);
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "direction": "INBOUND",
      "iterationCount": 123,
      "maxConcurrentJobs": 123,
      "maxSimulationDurationSeconds": 123,
      "silenceTimeoutSeconds": 123,
      "endCallPhrases": [
        "<string>"
      ],
      "executionMode": "PARALLEL",
      "scenarios": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "personas": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "agentEndpoints": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "evaluators": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "testCaseCount": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "description": "<string>"
    }
  ],
  "pagination": {
    "total": 123,
    "hasMore": true,
    "nextCursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

Maximum number of run plans to return (default: 20, max: 50)

Required range: 1 <= x <= 50
Example:

20

​
after
string

Cursor for pagination - use the nextCursor value from a previous response

​
searchText
string

Search text to filter run plans by name

​
agentId
string<uuid>

Filter run plans by agent ID

Response

Paginated list of run plans

Paginated list of simulation run plans

​
data
object[]
required
​
pagination
object
required