Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Query Parameters

limit
integer
default:25

Items per page, 1 to 100.

Required range: 1 <= x <= 100
Example:

25

cursor
string

nextCursor from the previous page.

Minimum string length: 1
version
integer

Only calls taken by this agent version.

outcome
enum<string>

Only analysed calls with this outcome.

Available options:
resolved,
unresolved,
transferred,
abandoned,
no_contact
issueId
string<uuid>

Only calls that are evidence for this issue.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

signal
string

Only calls with this signal code detected (GET /signals lists the codes).

Required string length: 1 - 200
startedAfter
string<date-time>

Only calls that started at or after this time. Calls with no start time never match.

startedBefore
string<date-time>

Only calls that started before this time. Calls with no start time never match.

Response

A page of calls.

object
enum<string>
required
Available options:
list
data
object[]
required
hasMore
boolean
required
nextCursor
string | null
required

Pass as cursor for the next page; null on the last page.