Get simulation runs by simulation - Cognigy Documentation

GET

simulations

{simulationReference}

batches

{simulationRunBatchReference}

runs

Get simulation runs by simulation

curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "organisationReference": "<string>",
      "projectReference": "<string>",
      "simulationReference": "<string>",
      "simulationRunBatchReference": "<string>",
      "sequence": 123,
      "largeLanguageModelReferenceId": "<string>",
      "turns": [
        {
          "id": "<string>",
          "sequence": 123,
          "text": "<string>",
          "data": {},
          "createdAt": 123
        }
      ],
      "totalTurns": 123,
      "successCriteria": [
        {
          "type": "<string>",
          "params": {}
        }
      ],
      "metrics": {
        "success": true,
        "results": [
          {}
        ],
        "successRate": {
          "percentage": 123,
          "numerator": 123,
          "denominator": 123
        },
        "summary": "<string>",
        "isBatchStopped": true,
        "isConversationEnded": true,
        "errorInfo": {
          "message": "<string>",
          "technicalDetails": "<string>"
        }
      },
      "createdAt": 123,
      "createdBy": "<string>",
      "endPointType": "<string>",
      "maxTurns": 123,
      "duration": 123,
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "skip": 123,
    "total": 123,
    "hasNext": true,
    "hasPrevious": true,
    "next": "<string>",
    "previous": "<string>"
  }
}

Authorizations

Authorization

string

header

required

JWT Bearer Token for authentication

Path Parameters

simulationReference

string

required

Reference ID of the scenario

simulationRunBatchReference

string

required

Reference ID of the simulation

Query Parameters

projectId

string

required

Project identifier

filter

string

Filter criteria for searching simulations

limit

integer

default:20

Number of items to return per page

Required range: 1 <= x <= 100

skip

integer

default:0

Number of items to skip

Required range: x >= 0

sort

string

Sort order (e.g., 'name:asc', 'createdAt:desc')

string

Pagination cursor for next page

string

Pagination cursor for previous page

endPointType

string

Filter by endpoint type

Response

List of simulation runs retrieved successfully

data

object[]

Array of simulation run objects

Show child attributes

pagination

object

Show child attributes

Last modified on July 2, 2026

Get simulation run by IDRetrieve a specific simulation run by its reference ID.

Get simulation runs by simulation

curl --request GET \
  --url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "organisationReference": "<string>",
      "projectReference": "<string>",
      "simulationReference": "<string>",
      "simulationRunBatchReference": "<string>",
      "sequence": 123,
      "largeLanguageModelReferenceId": "<string>",
      "turns": [
        {
          "id": "<string>",
          "sequence": 123,
          "text": "<string>",
          "data": {},
          "createdAt": 123
        }
      ],
      "totalTurns": 123,
      "successCriteria": [
        {
          "type": "<string>",
          "params": {}
        }
      ],
      "metrics": {
        "success": true,
        "results": [
          {}
        ],
        "successRate": {
          "percentage": 123,
          "numerator": 123,
          "denominator": 123
        },
        "summary": "<string>",
        "isBatchStopped": true,
        "isConversationEnded": true,
        "errorInfo": {
          "message": "<string>",
          "technicalDetails": "<string>"
        }
      },
      "createdAt": 123,
      "createdBy": "<string>",
      "endPointType": "<string>",
      "maxTurns": 123,
      "duration": 123,
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "skip": 123,
    "total": 123,
    "hasNext": true,
    "hasPrevious": true,
    "next": "<string>",
    "previous": "<string>"
  }
}