analytics

Calls By Region

Worldwide call distribution — calls aggregated by caller country.

Powers the dashboard’s “calls by region” map (choropleth keyed on ISO-2 country codes). Country is derived from the caller’s E.164 number at call-creation time via libphonenumber.

Response shape:

{
  "tenant_id": "...",
  "period": {"start": "2026-03-18T00:00:00Z", "end": "2026-04-17T23:59:59Z"},
  "regions": [
    {"country_code": "US", "country_name": "United States",
     "call_count": 1423, "total_minutes": 8921.5,
     "avg_duration_sec": 376, "inbound": 1200, "outbound": 223}
  ],
  "total_calls": 1735,
  "countries_count": 47,
  "calls_without_country": 12
}

Sorted by call_count DESC. country_code uses ISO 3166-1 alpha-2. Calls with no parseable phone number (web sessions, anonymous calls) are reported as calls_without_country.

GET

analytics

tenants

{tenant_id}

calls

by-region

Calls By Region

curl --request GET \
  --url https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region"

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}/calls/by-region', 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}/calls/by-region",
  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}/calls/by-region"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region")

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

tenant_id

string<uuid>

required

Query Parameters

start_date

string<date-time> | null

ISO start date (defaults to 30 days ago)

end_date

string<date-time> | null

ISO end date (defaults to now)

direction

string | null

Filter by call direction

Pattern: ^(inbound|outbound)$

Response

Successful Response

Calls By Region

curl --request GET \
  --url https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region"

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}/calls/by-region', 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}/calls/by-region",
  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}/calls/by-region"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/analytics/tenants/{tenant_id}/calls/by-region")

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Overview

Endpoints

Calls By Region

Authorizations

Path Parameters

Query Parameters

Response