Skip to main content
GET
/
api
/
v1
/
automations
/
{id}
/
experiments
List experiments
curl --request GET \
  --url https://studio.eigenpal.com/api/v1/automations/{id}/experiments \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "automationId": "<string>",
      "runCount": 0,
      "completedCount": 0,
      "passedCount": 0,
      "failedCount": 0,
      "avgScore": 123,
      "createdAt": "<string>",
      "completedAt": "<string>",
      "version": "<string>"
    }
  ],
  "total": 0,
  "limit": 0,
  "offset": 0
}

Authorizations

​
Authorization
string
header
required

API key issued from Settings → API Keys. Pass as Authorization: Bearer <key>.

Path Parameters

​
id
string
required

Automation id or typed alias.

Query Parameters

​
limit
integer

Maximum number of experiment batches to return.

Required range: 1 <= x <= 500
​
offset
integer

Zero-based offset for paging through experiment batches.

Required range: 0 <= x <= 9007199254740991
​
fromDate
string

Filter to experiment batches created at or after this date or relative date.

​
toDate
string

Filter to experiment batches created at or before this date or relative date.

Response

Page of experiment batches.

​
data
object[]
required
​
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
limit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991