Get simulation runs by simulation - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

Use this file to discover all available pages before exploring further.

GET /simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs

Try it

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

import requests

url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs?limit=20"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs?limit=20', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs?limit=20",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {
    
    url := "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs?limit=20"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Response Codes

Response Body Example

{
  "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>"
  }
}

Error Response Example

{
  "error": "<string>",
  "field": "<string>",
  "code": "<string>",
  "traceId": "<string>"
}

Authorizations

Authorization: JWT Bearer Token for authentication

Path Parameters

Query Parameters