Get all simulations - 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/batches

Try it

Get all simulations

cURL

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

Python

import requests

url = "https://api-trial.cognigy.ai/testing/simulations/batches?limit=20"

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

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

print(response.text)

JavaScript (Fetch)

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

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

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api-trial.cognigy.ai/testing/simulations/batches?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;
}

Go

package main

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

func main() {

url := "https://api-trial.cognigy.ai/testing/simulations/batches?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))
}

Java

HttpResponse<String> response = Unirest.get("https://api-trial.cognigy.ai/testing/simulations/batches?limit=20")
  .header("Authorization", "Bearer <token>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/testing/simulations/batches?limit=20")

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

Responses

200
400
401
403
500

Sample Response

{
  "data": [\
    {\
      "id": "<string>",\
      "referenceId": "<string>",\
      "simulationReference": "<string>",\
      "runs": 123,\
      "completedRuns": 123,\
      "failedRuns": 123,\
      "createdAt": 123,\
      "startedAt": 123,\
      "completedAt": 123\
    }\
  ],\
  "pagination": {\
    "limit": 123,\
    "skip": 123,\
    "total": 123,\
    "hasNext": true,\
    "hasPrevious": true,\
    "next": "<string>",\
    "previous": "<string>"
  }
}

Error Responses

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

Authorization

• Authorization
  Type: string
  In: header
  Required: JWT Bearer Token for authentication

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')
• next: string - Pagination cursor for next page
• previous: string - Pagination cursor for previous page
• status: enum - Filter by simulation status (Available options: STOPPED, IN_PROGRESS, COMPLETED, FAILED)
• timespan: string - Filter by time range (e.g., '7d', '30d', '1y')
• timezone: string - Timezone for timespan filtering (e.g., 'UTC', 'America/New_York')
• endPointType: string - Filter by endpoint type
• scenariosIds: string[] - Filter by simulation references (comma-separated list of simulation IDs)

Response

200 application/json - List of simulations retrieved successfully

• data: object[] - Array of simulation objects
• pagination: object - Contains pagination details.