Simulations
Get simulations by scenarios
Retrieve all simulations for a specific scenario.
get/simulations/{simulationReference}/batches
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- HTTP bearer
- or API key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
simulationReferencestring required
Reference ID of the scenario
Query parameters
projectIdstring required
Project identifier
filterstring
Filter criteria for searching simulations
limitinteger
Number of items to return per page
skipinteger
Number of items to skip
sortstring
Sort order (e.g., 'name:asc', 'createdAt:desc')
nextstring
Pagination cursor for next page
previousstring
Pagination cursor for previous page
status'STOPPED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED'
Filter by simulation status
timespanstring
Filter by time range (e.g., '7d', '30d', '1y')
timezonestring
Timezone for timespan filtering (e.g., 'UTC', 'America/New_York')
endPointTypestring
Filter by endpoint type
Response
List of simulations retrieved successfully
Changes
No recorded changes to this operation across all 1 revision of this API.