VocalDocscontracts 1.65.0

List the analyses of a Call

GET /v1/calls/{call_id}/analyses

PropertyValue
Operationlist_call_analyses
GroupOutcomes and analyses
Scopecalls:read
Scopes of include valuesvalues needs transcripts:read
Route classread
IdempotencyNo Idempotency-Key
AuditAn audited content read analysis.list, when the request names an include value
Released in1.56.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists every analysis of the Call, every run of each, oldest first (1.56.0): status, analyzer version, input, Provider, fields, usage and timing, and the metadata values; include=values adds every value, needs transcripts:read and is an audited content read.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the calls:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/calls/call_.../analyses" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
call_idpathCallIdyesThe id of a Call: call_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
kindqueryAnalyzerKindnoOnly the analyses of this kind.
includequeryarray of OutcomeIncludenoContent classes to add, comma-separated: values answers every value, needs transcripts:read and makes the read an audited content read (1.56.0).

Responses

StatusContent typeShapeError codes
200application/jsonAnalysisList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is AnalysisList.

FieldTypeRequiredDescription
dataarray of AnalysisyesThe analyses of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes