The estimated cost of the Calls of a window

GET /v1/analytics/cost

Rates the ended Calls of the window from the price list at read time. The figures are estimates from list prices, not a bill; the window is at most 30 days until a stored aggregate exists. Needs usage:read from 1.29.0 (workspace ADR 0078, decision 7), calls:read before it. From 1.57.0 (workspace ADR 0048, observability-and-analytics.md section 4.1) it reads the cost rollups, which are that aggregate: window=custom with from and to reads a range of up to 760 days (range_too_long); the filters narrow it; group_by groups by the fixed dimensions of ANALYTICS_DIMENSIONS_BY_REPORT.cost, any other answering 422 validation_failed and the issue dimension_not_supported; and the answer adds the amounts by Provider, lane and Agent version per billable minute, and per Outcome value for the Calls whose version declares a rollup Outcome field. A request of 1.56.0 answers as before.

Request

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

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

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