Calls, minutes, ended reasons, Outcomes and transfers over a window

GET /v1/analytics/calls

Counts the ended Calls of a window or range from the Call rollups (1.57.0, observability-and-analytics.md section 8.1): Calls, answered Calls, billable minutes, ended reasons, transfers, compliance-tagged Policy firings and the Outcome rates of the Calls whose Agent version declares a rollup Outcome field, about two minutes behind finalize (a target). group_by takes the fixed dimensions of ANALYTICS_DIMENSIONS_BY_REPORT.calls; any other answers 422 validation_failed with the issue dimension_not_supported, and a range over 760 days range_too_long.

Request

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

curl "$VOCAL_API/v1/analytics/calls" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

const response = await fetch(`${process.env.VOCAL_API}/v1/analytics/calls`, {
  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/analytics/calls",
    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 CallAnalytics.