Skip to main content
GET
/
workflows
/
v1
/
simulations
/
{simulation_id}
/
runs
Get Simulation Runs
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/simulations/{simulation_id}/runs \
  --header 'Authorization: Bearer <token>'
{
  "simulation_groups": [
    {
      "simulation_config_id": "5eb7cf5a86d9755df3a6c593",
      "team_id": "<string>",
      "created_by": "<string>",
      "updated_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "_id": "5eb7cf5a86d9755df3a6c593",
      "status": "pending",
      "total_runs": 0,
      "completed_runs": 0,
      "failed_runs": 0
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

​
simulation_id
string
required
Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

Query Parameters

​
size
integer
default:300

Number of items per page

Required range: x >= 1
​
page
integer
default:1

Page number

Required range: x >= 1
​
search
string | null

Search keywords

​
start
string<date-time> | null

Filter by start time (ISO 8601 format)

​
end
string<date-time> | null

Filter by end time (ISO 8601 format)

Response

Successful Response

Response model for a list of simulation groups. Contains a list of SimulationGroupModel objects.

​
simulation_groups
SimulationGroupModel · object[]

List of simulation groups

​
total
integer | null

Total number of simulation groups available without pagination.