curl --request GET \
--url https://app.famulor.io/api/v1/campaigns/{id}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/campaigns/{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/campaigns/{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/campaigns/{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/campaigns/{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/campaigns/{id}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{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": {
"available": true,
"campaign_kind": "sequence",
"range": {
"from": "2026-11-01T00:00:00.000Z",
"to": "2026-11-10T00:00:00.000Z",
"timezone": "Europe/Berlin"
},
"kpis": {
"dialed": 2,
"connected": 1,
"converted": 1,
"conversion_rate": 0.5,
"dials": 3,
"connected_calls": 1,
"total_duration_sec": 61
},
"enrolled": 4,
"enroll_failed": 0,
"sankey": {
"nodes": [
{
"id": "0:enrolled",
"key": "enrolled",
"label": "Enrolled",
"kind": "root",
"step": 0,
"value": 4
},
{
"id": "1:goal_reached",
"key": "goal_reached",
"label": "Goal reached",
"kind": "converted",
"step": 1,
"value": 1
},
{
"id": "1:~waiting",
"key": "waiting",
"label": "Waiting",
"kind": "final",
"step": 1,
"value": 3
}
],
"links": [
{
"source": "0:enrolled",
"target": "1:~waiting",
"value": 3
},
{
"source": "0:enrolled",
"target": "1:goal_reached",
"value": 1
}
]
},
"series": [
{
"day": "2026-11-01",
"dials": 3,
"connected": 1,
"converted": 1
}
],
"caller_numbers": [
{
"phone_number_id": "b1c2d3e4-0000-4000-8000-000000000002",
"number": "+4930123456",
"dials": 3
}
],
"currency": "EUR",
"display_currency": "EUR",
"display_currency_rate": 1
}
}Get campaign analytics
Per-contact analytics of a campaign for a period: dialed, connected and converted contacts, the conversion rate, the messages sent by message steps, the outcome flow of the sequence, activity per day and the caller numbers used. Without from and to the figures cover all time. The period spans at most 366 days. Provider cost is not part of this response. Required scope: campaigns:read (the legacy calls:read scope is also accepted; keys without scope restrictions have full access).
curl --request GET \
--url https://app.famulor.io/api/v1/campaigns/{id}/analytics \
--header 'Authorization: Bearer <token>'import requests
url = "https://app.famulor.io/api/v1/campaigns/{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/campaigns/{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/campaigns/{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/campaigns/{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/campaigns/{id}/analytics")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.famulor.io/api/v1/campaigns/{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": {
"available": true,
"campaign_kind": "sequence",
"range": {
"from": "2026-11-01T00:00:00.000Z",
"to": "2026-11-10T00:00:00.000Z",
"timezone": "Europe/Berlin"
},
"kpis": {
"dialed": 2,
"connected": 1,
"converted": 1,
"conversion_rate": 0.5,
"dials": 3,
"connected_calls": 1,
"total_duration_sec": 61
},
"enrolled": 4,
"enroll_failed": 0,
"sankey": {
"nodes": [
{
"id": "0:enrolled",
"key": "enrolled",
"label": "Enrolled",
"kind": "root",
"step": 0,
"value": 4
},
{
"id": "1:goal_reached",
"key": "goal_reached",
"label": "Goal reached",
"kind": "converted",
"step": 1,
"value": 1
},
{
"id": "1:~waiting",
"key": "waiting",
"label": "Waiting",
"kind": "final",
"step": 1,
"value": 3
}
],
"links": [
{
"source": "0:enrolled",
"target": "1:~waiting",
"value": 3
},
{
"source": "0:enrolled",
"target": "1:goal_reached",
"value": 1
}
]
},
"series": [
{
"day": "2026-11-01",
"dials": 3,
"connected": 1,
"converted": 1
}
],
"caller_numbers": [
{
"phone_number_id": "b1c2d3e4-0000-4000-8000-000000000002",
"number": "+4930123456",
"dials": 3
}
],
"currency": "EUR",
"display_currency": "EUR",
"display_currency_rate": 1
}
}Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.