Skip to main content
GET
/
api
/
v1
/
calls
/
analytics
Get Call Analytics
curl --request GET \
  --url https://api.example.com/api/v1/calls/analytics \
  --header 'Authorization: Bearer <token>'
{
  "total_calls": 123,
  "completed_calls": 123,
  "failed_calls": 123,
  "ongoing_calls": 123,
  "total_duration": 123,
  "avg_duration": 123,
  "success_rate": 123,
  "daily_stats": {},
  "top_assistants": [
    {
      "assistant_id": 123,
      "assistant_name": "<string>",
      "calls": 123,
      "duration": 123
    }
  ]
}
This endpoint provides detailed analytics and trends for the calls within your organization over a specified time period.

​
Query Parameters

  • period (string, optional, default: 7d): The time period for the analysis.
    • Allowed values: 1d, 7d, 30d, 90d.

​
Response

The response is a JSON object containing a comprehensive breakdown of call metrics.
Response
{
  "total_calls": 150,
  "completed_calls": 135,
  "failed_calls": 10,
  "ongoing_calls": 5,
  "total_duration": 40500,
  "avg_duration": 300,
  "success_rate": 90,
  "daily_stats": {
    "2023-10-29": {
      "total": 70,
      "completed": 65,
      "failed": 5
    },
    "2023-10-30": {
      "total": 80,
      "completed": 70,
      "failed": 5
    }
  },
  "top_assistants": [
    {
      "assistant_id": 123,
      "assistant_name": "Support Bot",
      "calls": 100,
      "duration": 30000
    },
    {
      "assistant_id": 456,
      "assistant_name": "Sales Rep",
      "calls": 50,
      "duration": 10500
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
period
string
default:7d

Analysis period

Pattern: ^(1d|7d|30d|90d)$

Response

Successful Response

Response model for call analytics.

​
total_calls
integer
required
​
completed_calls
integer
required
​
failed_calls
integer
required
​
ongoing_calls
integer
required
​
total_duration
number
required
​
avg_duration
number
required
​
success_rate
number
required
​
daily_stats
Daily Stats · object
required
​
top_assistants
AssistantStat · object[]
required