Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Path Parameters

agent_id
string
required

ID of the agent whose evaluations to list. Also accepts the reserved aliases gumball and analytics.

Query Parameters

page_size
integer
default:20

Number of evaluations to return per page (1-100).

Required range: 1 <= x <= 100
cursor
string

Pagination cursor from a previous response's next_cursor field.

grade
enum<string>

Filter evaluations by grade.

Available options:
pass,
needs_review,
needs_attention
status
enum<string>

Return evaluations in one lifecycle state instead of the default completed and failed set.

Available options:
queued,
in_progress,
completed,
failed
session_id
string

Only evaluations of this session.

created_after
string<date-time>

Only evaluations created at or after this ISO 8601 timestamp. Timestamps without an offset are read as UTC.

created_before
string<date-time>

Only evaluations created before this ISO 8601 timestamp. Timestamps without an offset are read as UTC.

Response

Paginated list of evaluation results.

evaluations
object[]
next_cursor
string | null

Pass this value as the cursor query parameter to fetch the next page. Null when there are no more results.