curl --request GET \
--url https://app.famulor.io/api/v1/dashboards/{id}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/dashboards/{id}/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/dashboards/{id}/analytics', 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://app.famulor.io/api/v1/dashboards/{id}/analytics",
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://app.famulor.io/api/v1/dashboards/{id}/analytics"
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://app.famulor.io/api/v1/dashboards/{id}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/dashboards/{id}/analytics")
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{
"data": {
"filters": {
"current": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"days": 2
},
"previous": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"days": 2
},
"assistant_ids": [
"<string>"
],
"campaign_ids": [
"<string>"
],
"directions": [
"<string>"
],
"statuses": [
"<string>"
],
"sentiments": [
"<string>"
],
"success": true,
"compare": true
},
"context": {
"features": {
"custom_dashboards": true,
"assistants": true,
"campaigns": true,
"bookings": true,
"knowledge": true,
"simulations": true,
"live_monitoring": true,
"tools": true,
"phone_numbers": true
},
"assistants": [
{
"id": "<string>",
"name": "<string>",
"is_active": true
}
],
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"assistant_id": "<string>"
}
]
},
"overview": {
"total_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"completed_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"analyzed_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"total_duration_sec": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"avg_duration_sec": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"completion_rate": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"success_rate": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
}
},
"time_series": {
"current": [
{
"bucket": 1,
"date": "2023-12-25",
"total_calls": 123,
"completed_calls": 123,
"successful_calls": 123,
"duration_sec": 123
}
],
"previous": [
{
"bucket": 1,
"date": "2023-12-25",
"total_calls": 123,
"completed_calls": 123,
"successful_calls": 123,
"duration_sec": 123
}
]
},
"breakdowns": {
"status": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"direction": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"sentiment": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"success": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"outcome": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
]
},
"top_assistants": [
{
"assistant_id": "<string>",
"assistant_name": "<string>",
"total_calls": 123,
"completed_calls": 123,
"total_duration_sec": 123,
"success_rate": 123
}
],
"campaign_progress": [
{
"campaign_id": "<string>",
"campaign_name": "<string>",
"status": "<string>",
"total_leads": 123,
"completed_leads": 123,
"remaining_leads": 123,
"calls_made": 123,
"progress_percent": 123,
"total_duration_sec": 123,
"period_calls": 123,
"period_success_rate": 123
}
],
"recent_calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_id": "<string>",
"assistant_name": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"direction": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"duration_sec": 123,
"sentiment": "<string>",
"success": true,
"outcome": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"optional": {
"bookings": {
"total": 123,
"by_status": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"by_source": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
]
},
"knowledge": {
"knowledge_bases": 123,
"documents": 123,
"ready_documents": 123,
"processing_documents": 123,
"error_documents": 123,
"total_chunks": 123
},
"simulations": {
"total_runs": 123,
"running": 123,
"passed": 123,
"failed": 123,
"error": 123,
"average_score": 123
},
"live_monitoring": {
"active_calls": 123,
"latency": {
"e2e_latency_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"llm_ttft_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"tts_ttfb_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"stt_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
}
}
}
},
"quality": {
"calls_truncated": true,
"context_truncated": true,
"warnings": [
"<string>"
]
},
"generated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}Get dashboard analytics
Tenant-scoped call KPIs and deltas, zero-filled daily activity, breakdowns, assistant ranking, campaign progress, recent calls, and plan-gated module summaries. Date buckets follow the workspace timezone. Required scope: dashboards:read or calls:read.
curl --request GET \
--url https://app.famulor.io/api/v1/dashboards/{id}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/dashboards/{id}/analytics"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://app.famulor.io/api/v1/dashboards/{id}/analytics', 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://app.famulor.io/api/v1/dashboards/{id}/analytics",
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://app.famulor.io/api/v1/dashboards/{id}/analytics"
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://app.famulor.io/api/v1/dashboards/{id}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/dashboards/{id}/analytics")
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{
"data": {
"filters": {
"current": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"days": 2
},
"previous": {
"from": "2023-11-07T05:31:56Z",
"to": "2023-11-07T05:31:56Z",
"days": 2
},
"assistant_ids": [
"<string>"
],
"campaign_ids": [
"<string>"
],
"directions": [
"<string>"
],
"statuses": [
"<string>"
],
"sentiments": [
"<string>"
],
"success": true,
"compare": true
},
"context": {
"features": {
"custom_dashboards": true,
"assistants": true,
"campaigns": true,
"bookings": true,
"knowledge": true,
"simulations": true,
"live_monitoring": true,
"tools": true,
"phone_numbers": true
},
"assistants": [
{
"id": "<string>",
"name": "<string>",
"is_active": true
}
],
"campaigns": [
{
"id": "<string>",
"name": "<string>",
"status": "<string>",
"assistant_id": "<string>"
}
]
},
"overview": {
"total_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"completed_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"analyzed_calls": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"total_duration_sec": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"avg_duration_sec": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"completion_rate": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
},
"success_rate": {
"value": 123,
"previous_value": 123,
"delta": 123,
"delta_percent": 123
}
},
"time_series": {
"current": [
{
"bucket": 1,
"date": "2023-12-25",
"total_calls": 123,
"completed_calls": 123,
"successful_calls": 123,
"duration_sec": 123
}
],
"previous": [
{
"bucket": 1,
"date": "2023-12-25",
"total_calls": 123,
"completed_calls": 123,
"successful_calls": 123,
"duration_sec": 123
}
]
},
"breakdowns": {
"status": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"direction": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"sentiment": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"success": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"outcome": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
]
},
"top_assistants": [
{
"assistant_id": "<string>",
"assistant_name": "<string>",
"total_calls": 123,
"completed_calls": 123,
"total_duration_sec": 123,
"success_rate": 123
}
],
"campaign_progress": [
{
"campaign_id": "<string>",
"campaign_name": "<string>",
"status": "<string>",
"total_leads": 123,
"completed_leads": 123,
"remaining_leads": 123,
"calls_made": 123,
"progress_percent": 123,
"total_duration_sec": 123,
"period_calls": 123,
"period_success_rate": 123
}
],
"recent_calls": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assistant_id": "<string>",
"assistant_name": "<string>",
"campaign_id": "<string>",
"campaign_name": "<string>",
"direction": "<string>",
"from_number": "<string>",
"to_number": "<string>",
"status": "<string>",
"duration_sec": 123,
"sentiment": "<string>",
"success": true,
"outcome": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"optional": {
"bookings": {
"total": 123,
"by_status": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
],
"by_source": [
{
"key": "<string>",
"label": "<string>",
"count": 123,
"percentage": 50
}
]
},
"knowledge": {
"knowledge_bases": 123,
"documents": 123,
"ready_documents": 123,
"processing_documents": 123,
"error_documents": 123,
"total_chunks": 123
},
"simulations": {
"total_runs": 123,
"running": 123,
"passed": 123,
"failed": 123,
"error": 123,
"average_score": 123
},
"live_monitoring": {
"active_calls": 123,
"latency": {
"e2e_latency_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"llm_ttft_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"tts_ttfb_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
},
"stt_ms": {
"p50": 123,
"p95": 123,
"sample_count": 123
}
}
}
},
"quality": {
"calls_truncated": true,
"context_truncated": true,
"warnings": [
"<string>"
]
},
"generated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "invalid_request",
"message": "\"to_number\" is required (E.164 format, e.g. +4930123456)."
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key is missing the required scope \"assistants:write\"."
}
}{
"error": {
"code": "not_found",
"message": "Assistant not found"
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Path Parameters
Dashboard ID.
Query Parameters
7d, 14d, 30d, 90d Inclusive ISO date or timestamp.
A date is inclusive; a timestamp is an exclusive boundary.
Comma-separated assistant IDs (max 50).
Comma-separated campaign IDs (max 50).
Comma-separated call directions.
Comma-separated call statuses.
Comma-separated post-call sentiments.
Compare with the immediately preceding equal-length period.
Response
Dashboard analytics.
Show child attributes
Show child attributes