Skip to main content
GET
List agent runs

Authorizations

Authorization
string
header
required

Your project's secret key (pk_…, without the pub segment). Server-side only — never ship it to a browser. Get it from Settings → Projects in the dashboard.

Query Parameters

kind
string

Only runs of this kind.

Maximum string length: 200
goalId
string

Only runs serving this goal.

Maximum string length: 200
campaignId
string

Only runs for this campaign.

page
integer
default:1

Page number.

Required range: x >= 1
perPage
integer
default:50

Items per page (max 100).

Required range: 1 <= x <= 100
include
enum<string>

Set to names to add a top-level references map of goal and campaign names for the returned runs.

Available options:
names

Response

The project's agent runs.

runs
object[]
required
total
integer
required
Example:

412

page
integer
required
Example:

1

pageCount
integer
required
Example:

9

references
object

Names for the first-class goalId and campaignId values on the returned runs. Free-form run JSON is never inspected.