Team metrics
curl --request POST \
--url https://api.withallo.com/v2/api/analytics/overview \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"user_ids": [
"usr-abc123",
"usr-def456"
]
}
'import requests
url = "https://api.withallo.com/v2/api/analytics/overview"
payload = {
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"user_ids": ["usr-abc123", "usr-def456"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: {from: '2026-03-25', to: '2026-04-21'},
compare_date: {from: '2026-02-25', to: '2026-03-24'},
user_ids: ['usr-abc123', 'usr-def456']
})
};
fetch('https://api.withallo.com/v2/api/analytics/overview', 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.withallo.com/v2/api/analytics/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'date' => [
'from' => '2026-03-25',
'to' => '2026-04-21'
],
'compare_date' => [
'from' => '2026-02-25',
'to' => '2026-03-24'
],
'user_ids' => [
'usr-abc123',
'usr-def456'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/analytics/overview"
payload := strings.NewReader("{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/analytics/overview")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/analytics/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"summary": {
"total_calls": {
"value": 2899,
"previous": 2512,
"change": 0.15
},
"talk_time_seconds": {
"value": 81720,
"previous": 103380,
"change": -0.21
},
"calls_over_1_min": {
"value": 290,
"previous": 310,
"change": -0.06
},
"answer_rate": {
"value": 0.503,
"previous": 0.46,
"change": 0.09
}
},
"breakdown": [
{
"user": {
"id": "usr-abc123",
"name": "Adrien Gaucher",
"email": "[email protected]"
},
"calls": {
"value": 673,
"change": -0.05
},
"talk_time_seconds": {
"value": 38460,
"change": -0.11
},
"calls_over_1_min": {
"value": 141,
"change": -0.1
},
"answer_rate": {
"value": 0.645,
"change": -0.03
}
}
],
"last_updated": "2026-04-21T19:07:00Z"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Analytics
Team metrics
Returns team-wide KPIs with period-over-period comparison and a per-user breakdown. Covers all calls (inbound + outbound).
POST
/
v2
/
api
/
analytics
/
overview
Team metrics
curl --request POST \
--url https://api.withallo.com/v2/api/analytics/overview \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"user_ids": [
"usr-abc123",
"usr-def456"
]
}
'import requests
url = "https://api.withallo.com/v2/api/analytics/overview"
payload = {
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"user_ids": ["usr-abc123", "usr-def456"]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: {from: '2026-03-25', to: '2026-04-21'},
compare_date: {from: '2026-02-25', to: '2026-03-24'},
user_ids: ['usr-abc123', 'usr-def456']
})
};
fetch('https://api.withallo.com/v2/api/analytics/overview', 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.withallo.com/v2/api/analytics/overview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'date' => [
'from' => '2026-03-25',
'to' => '2026-04-21'
],
'compare_date' => [
'from' => '2026-02-25',
'to' => '2026-03-24'
],
'user_ids' => [
'usr-abc123',
'usr-def456'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.withallo.com/v2/api/analytics/overview"
payload := strings.NewReader("{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.withallo.com/v2/api/analytics/overview")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/analytics/overview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": {\n \"from\": \"2026-03-25\",\n \"to\": \"2026-04-21\"\n },\n \"compare_date\": {\n \"from\": \"2026-02-25\",\n \"to\": \"2026-03-24\"\n },\n \"user_ids\": [\n \"usr-abc123\",\n \"usr-def456\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"date": {
"from": "2026-03-25",
"to": "2026-04-21"
},
"compare_date": {
"from": "2026-02-25",
"to": "2026-03-24"
},
"summary": {
"total_calls": {
"value": 2899,
"previous": 2512,
"change": 0.15
},
"talk_time_seconds": {
"value": 81720,
"previous": 103380,
"change": -0.21
},
"calls_over_1_min": {
"value": 290,
"previous": 310,
"change": -0.06
},
"answer_rate": {
"value": 0.503,
"previous": 0.46,
"change": 0.09
}
},
"breakdown": [
{
"user": {
"id": "usr-abc123",
"name": "Adrien Gaucher",
"email": "[email protected]"
},
"calls": {
"value": 673,
"change": -0.05
},
"talk_time_seconds": {
"value": 38460,
"change": -0.11
},
"calls_over_1_min": {
"value": 141,
"change": -0.1
},
"answer_rate": {
"value": 0.645,
"change": -0.03
}
}
],
"last_updated": "2026-04-21T19:07:00Z"
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
CONVERSATIONS_READAuthorizations
Body
application/json
Show child attributes
Show child attributes
Comparison period. Metrics will include change vs this period.
Show child attributes
Show child attributes
Filter by user IDs. Cannot be combined with allo_numbers.
Filter by Allo numbers (E.164). Cannot be combined with user_ids.
Response
Team summary
Show child attributes
Show child attributes
Was this page helpful?
⌘I