analytics
Get Dashboard Analytics
Get comprehensive analytics for tenant dashboard.
This is the main endpoint for dashboard rendering. Returns all metrics in one response:
- Real-time metrics
- Call statistics
- Capacity metrics
- Per-agent performance
Use this endpoint to populate the main dashboard view.
Example Response:
{
"tenant_id": "...",
"generated_at": "2025-12-04T10:00:00Z",
"period_hours": 24,
"real_time": {
"active_calls": 5,
"active_participants": 10,
"active_agents": 5
},
"call_statistics": {
"total_calls": 150,
"success_rate": 95.5,
"avg_duration_seconds": 180
},
"capacity": {
"current_active_calls": 5,
"total_capacity": 50,
"utilization_percentage": 10.0
},
"agents": [
{
"agent_id": "...",
"agent_name": "Customer Support Agent",
"calls": {...},
"tools": {...}
}
]
}
GET
/
analytics
/
tenants
/
{tenant_id}
/
dashboard
Get Dashboard Analytics
curl --request GET \
--url https://api.example.com/analytics/tenants/{tenant_id}/dashboard \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/analytics/tenants/{tenant_id}/dashboard"
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/analytics/tenants/{tenant_id}/dashboard', 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/analytics/tenants/{tenant_id}/dashboard",
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/analytics/tenants/{tenant_id}/dashboard"
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/analytics/tenants/{tenant_id}/dashboard")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/analytics/tenants/{tenant_id}/dashboard")
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{
"tenant_id": "<string>",
"generated_at": "<string>",
"period_hours": 123,
"real_time": {},
"call_statistics": {},
"capacity": {},
"agents": [
"<unknown>"
],
"quota": {
"tenant_id": "<string>",
"monthly_call_limit": 123,
"calls_used_this_month": 123,
"calls_remaining": 123,
"calls_usage_percentage": 123,
"max_concurrent_calls": 123,
"current_active_calls": 123,
"concurrent_calls_remaining": 123,
"concurrent_usage_percentage": 123,
"total_minutes_used": 123,
"quota_exceeded": true,
"status": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Time period in hours (1-168)
Required range:
1 <= x <= 168Response
Successful Response
Complete dashboard analytics.
⌘I
Get Dashboard Analytics
curl --request GET \
--url https://api.example.com/analytics/tenants/{tenant_id}/dashboard \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/analytics/tenants/{tenant_id}/dashboard"
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/analytics/tenants/{tenant_id}/dashboard', 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/analytics/tenants/{tenant_id}/dashboard",
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/analytics/tenants/{tenant_id}/dashboard"
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/analytics/tenants/{tenant_id}/dashboard")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/analytics/tenants/{tenant_id}/dashboard")
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{
"tenant_id": "<string>",
"generated_at": "<string>",
"period_hours": 123,
"real_time": {},
"call_statistics": {},
"capacity": {},
"agents": [
"<unknown>"
],
"quota": {
"tenant_id": "<string>",
"monthly_call_limit": 123,
"calls_used_this_month": 123,
"calls_remaining": 123,
"calls_usage_percentage": 123,
"max_concurrent_calls": 123,
"current_active_calls": 123,
"concurrent_calls_remaining": 123,
"concurrent_usage_percentage": 123,
"total_minutes_used": 123,
"quota_exceeded": true,
"status": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}