Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
scenarios
/
batch-runs
List Batch Runs
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/scenarios/batch-runs \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "agent_name": "<string>",
    "status": "queued",
    "total_scenarios": 123,
    "completed_scenarios": 123,
    "passed_scenarios": 123,
    "failed_scenarios": 123,
    "error_scenarios": 123,
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

​
id
string<uuid>
required
​
agent_id
string<uuid>
required
​
agent_name
string
required
​
status
enum<string>
required

Status of a batch run across all scenarios.

Available options:
queued,
running,
completed,
error
​
total_scenarios
integer
required
​
completed_scenarios
integer
required
​
passed_scenarios
integer
required
​
failed_scenarios
integer
required
​
error_scenarios
integer
required
​
started_at
string<date-time> | null
required
​
completed_at
string<date-time> | null
required
​
created_at
string<date-time>
required