Skip to main content
GET
/
v1
/
simulation
/
plan
/
{planId}
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 response = await client.simulationRunPlan.getByID('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(response.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>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
planId
string<uuid>
required

The ID of the run plan to retrieve

Response

The requested run plan

​
data
object
required

A simulation run plan defining the test matrix