Skip to main content
GET
/
v1
/
stats
/
basic
Retrieve aggregate statistics for analyzed calls
curl --request GET \
  --url https://api.example.com/v1/stats/basic \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/v1/stats/basic"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/v1/stats/basic', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/stats/basic",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v1/stats/basic"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/stats/basic")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/stats/basic")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "total_requests": 1250,
  "avg_score": 82.5,
  "min_score": 45,
  "max_score": 98,
  "avg_duration": "00:05:23",
  "min_duration": "00:01:15",
  "max_duration": "00:25:47",
  "total_agents": 45,
  "count_by_status": {
    "COMPLETED": 1200,
    "PROCESSING": 30,
    "FAILED": 20
  },
  "extracted_variables": [
    "greeting_quality",
    "resolution_achieved",
    "customer_satisfaction"
  ],
  "score_by_category": [
    {
      "category": "Opening",
      "avg_score": 88.5
    },
    {
      "category": "Resolution",
      "avg_score": 79.2
    }
  ],
  "agent_stats": [
    {
      "agent_id": "AGT-001",
      "agent_name": "John Smith",
      "call_count": 150,
      "avg_score": 85.2
    }
  ]
}
{
"code": "001-001-0001",
"message": "The requested resource was not found"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string<date-time>
required

Start of date range (UTC)

end_date
string<date-time>
required

End of date range (UTC)

model_name
string
required

Name of the analysis model to filter by

Response

Successful Response

Aggregate statistics for analyzed calls within a date range

total_requests
integer
required

Total number of analyzed calls in the period

Example:

1250

avg_score
number

Average Neurascore percentage across all calls

Example:

82.5

min_score
number

Lowest Neurascore percentage

Example:

45

max_score
number

Highest Neurascore percentage

Example:

98

avg_duration
string

Average call duration (HH:MM:SS)

Example:

"00:05:23"

min_duration
string

Shortest call duration

Example:

"00:01:15"

max_duration
string

Longest call duration

Example:

"00:25:47"

total_agents
integer

Number of unique agents in the period

Example:

45

count_by_status
Count By Status · object

Breakdown of calls by processing status

Example:
{
"COMPLETED": 1200,
"PROCESSING": 30,
"FAILED": 20
}
extracted_variables
string[]

List of available extracted variable keys

Example:
[
"greeting_quality",
"resolution_achieved",
"customer_satisfaction"
]
score_by_category
Score By Category · object[]

Average scores broken down by evaluation category

Example:
[
{ "category": "Opening", "avg_score": 88.5 },
{
"category": "Resolution",
"avg_score": 79.2
}
]
agent_stats
Agent Stats · object[]

Per-agent performance statistics

Example:
[
{
"agent_id": "AGT-001",
"agent_name": "John Smith",
"call_count": 150,
"avg_score": 85.2
}
]