Sign in
Simulations

List Simulations

get/eval/simulation

Query parameters

idAnystring[]

Return only simulations matching the provided ids

standaloneOnlyboolean

Only include simulations that are not part of a suite

pagenumber

This is the page number to return. Defaults to 1.

sortOrder'ASC' | 'DESC'

This is the sort order for pagination. Defaults to 'DESC'.

sortBy'createdAt' | 'duration' | 'cost'

This is the column to sort by. Defaults to 'createdAt'.

limitnumber

This is the maximum number of items to return. Defaults to 100.

createdAtGtstring date-time

This will return items where the createdAt is greater than the specified value.

createdAtLtstring date-time

This will return items where the createdAt is less than the specified value.

createdAtGestring date-time

This will return items where the createdAt is greater than or equal to the specified value.

createdAtLestring date-time

This will return items where the createdAt is less than or equal to the specified value.

updatedAtGtstring date-time

This will return items where the updatedAt is greater than the specified value.

updatedAtLtstring date-time

This will return items where the updatedAt is less than the specified value.

updatedAtGestring date-time

This will return items where the updatedAt is greater than or equal to the specified value.

updatedAtLestring date-time

This will return items where the updatedAt is less than or equal to the specified value.

Response

idstring uuid required

This is the unique identifier for the simulation.

orgIdstring uuid required

This is the unique identifier for the organization this simulation belongs to.

createdAtstring date-time required

This is the ISO 8601 date-time string of when the simulation was created.

updatedAtstring date-time required

This is the ISO 8601 date-time string of when the simulation was last updated.

namestring

This is an optional friendly name for the simulation.

scenarioIdstring uuid required

This is the ID of the scenario to use for this simulation.

personalityIdstring uuid required

This is the ID of the personality to use for this simulation.

pathstring nullable

Optional folder path for organizing simulations. Supports up to 3 levels (e.g., "dept/feature/variant"). Maps to GitOps resource folder structure.

Example response

[
  {
    "name": "Eligible Path with Confused User"
  }
]

Changes