Simulation Runs
Get simulation runs by simulation
Retrieve all simulation runs for a specific simulation.
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>'import requests
url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs"
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', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}Authorizations
bearerAuthapiKeyAuth
JWT Bearer Token for authentication
Path Parameters
Reference ID of the scenario
Reference ID of the simulation
Query Parameters
Project identifier
Filter criteria for searching simulations
Number of items to return per page
Required range:
1 <= x <= 100Number of items to skip
Required range:
x >= 0Sort order (e.g., 'name:asc', 'createdAt:desc')
Pagination cursor for next page
Pagination cursor for previous page
Filter by endpoint type
Last modified on July 2, 2026
⌘I
Get simulation runs by simulation
curl --request GET \
--url https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs"
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', 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",
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"
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))
}HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/testing/simulations/{simulationReference}/batches/{simulationRunBatchReference}/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"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": "<string>",
"field": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}{
"error": "<string>",
"code": "<string>",
"traceId": "<string>"
}