Skip to main content
GET
List started scenario runs for a benchmark run.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The BenchmarkRun ID.

Query Parameters

state
enum<string>

Filter by Scenario Run state

Available options:
running,
scoring,
scored,
completed,
canceled,
timeout,
failed
limit
integer<int32>

The limit of items to return. Default is 20. Max is 5000.

starting_after
string

Load the next page of data starting after the item with the given ID.

include_total_count
boolean

If true (default), includes total_count in the response. Set to false to skip the count query for better performance on large datasets.

Response

200 - application/json

OK

runs
object[]
required

List of ScenarioRuns matching filter.

has_more
boolean
required
total_count
integer<int32> | null