Compare a Call with another Call or with its baseline

GET /v1/calls/{call_id}/compare

Aligns this finalized Call with with, another finalized Call of the Organization, Turn by Turn, and answers each pair's stage, Provider, Policy and cost deltas (1.57.0); with=baseline compares each Turn with the trailing 7-day percentiles of the Call's Agent version, from the rollups. A Call of another Organization, or one not yet finalized, is not found. align=state was refused with 422 capability_not_available and the detail align_state_not_available in 1.57.0; from 1.58.0 (roadmap slice 2.12) it pairs the Turns of two Calls by the speaker state each ran in, and only with=baseline&align=state is refused that way, because the rollups keep no state. The cost deltas need usage:read and are null without it.

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_.../compare?with=call_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/calls/call_.../compare?with=call_...`, {
  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_.../compare",
    params={
        "with": "call_...",
    },
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is CallComparison.