Skip to the content

Read one analysis of a Call

GET /v1/calls/{call_id}/analyses/{analysis_id}

Property	Value
Operation	`get_call_analysis`
Group	Outcomes and analyses
Scope	`calls:read`
Scopes of `include` values	`values` needs `transcripts:read`
Route class	`read`
Idempotency	No `Idempotency-Key`
Audit	An audited content read `analysis.read`, when the request names an `include` value
Released in	1.56.0
Phase 0 host	Served (the hosted api pins 1.65.0)

Answers one analysis (1.56.0; call-lifecycle-hooks-and-events.md section 3.9), with the metadata values; include=values adds every value, a summary included, 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/anl_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/calls/call_.../analyses/anl_...`, {
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.get(
    f"{os.environ['VOCAL_API']}/v1/calls/call_.../analyses/anl_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Name	In	Type	Required	Description
`call_id`	path	CallId	yes	The id of a Call: `call_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`analysis_id`	path	AnalysisId	yes	The id of one analysis of a Call: `anl_` and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
`include`	query	array of OutcomeInclude	no	Content classes to add, comma-separated: `values` answers every value, needs `transcripts:read` and makes the read an audited content read (1.56.0).

Responses

Status	Content type	Shape	Error codes
`200`	`application/json`	Analysis
`400`	`application/json`	ErrorEnvelope	`invalid_request`
`401`	`application/json`	ErrorEnvelope	`unauthenticated`
`403`	`application/json`	ErrorEnvelope	`forbidden`
`404`	`application/json`	ErrorEnvelope	`not_found`
`429`	`application/json`	ErrorEnvelope	`rate_limited`
`500`	`application/json`	ErrorEnvelope	`internal_error`

Fields of the `200` answer

The shape is Analysis.

Field	Type	Required	Description
`advisory`	boolean	yes	True when a judge produced the result and has not passed its calibration (section 3.5); false for `summary` and `outcomes`.
`analysis_ms`	integer or null	yes	How long the analyzer ran, a measurement; null until settled.
`analyzer`	AnalyzerRef	yes
`call_id`	CallId	yes
`completed_at`	Timestamp or null	yes	When it settled; null before.
`created_at`	Timestamp	yes
`environment`	Environment	yes
`error_code`	string or null	yes	Why it `failed` or was `skipped`, such as `transcript_unavailable`; else null.
`fields`	map of AnalysisField	yes	The output fields with their types and `phi` flags; configuration.
`id`	AnalysisId	yes
`input`	AnalysisInputFacts	yes
`job_id`	JobId or null	yes	The `call.analyze` job that runs it.
`object`	`"analysis"`	yes
`provider`	AnalysisProvider or null	yes	Null before the run.
`run`	integer	yes
`scrubbed_at`	Timestamp or null	yes	When the retention scrub nulled the values with the Call; null before.
`status`	AnalysisStatus	yes
`usage`	AnalysisUsage or null	yes	Null until settled.
`values`	AnalysisValues or null	yes	The values this read may answer: those of `phi: false` fields of a type that is not free text, and with `include=values` every value. Null until `completed`, and once scrubbed.