tenants

Get Tenant Stats

Get tenant usage statistics and analytics.

Purpose: View usage statistics, performance metrics, and billing data

What it returns:

{
  "tenant_id": "uuid",
  "total_agents": 5,              // Number of AI agents created
  "total_calls_today": 23,        // Today's call volume
  "total_calls_month": 456,       // Monthly call volume
  "avg_call_duration": 180.5,     // Average call length (seconds)
  "avg_sentiment_score": 0.75,    // Customer satisfaction (-1 to 1)
  "active_sessions": 3,            // Current active calls/sessions
  "monthly_usage_cents": 1250,    // Billing amount for current month
  "last_call_at": "2025-10-02T10:30:00Z"  // Last call timestamp
}

Used For:

Billing calculations: Track monthly_usage_cents for invoicing
Usage monitoring: Check if approaching monthly_call_limit
Customer dashboards: Display usage stats to tenant users
Capacity planning: Monitor concurrent calls vs max_concurrent_calls
Performance tracking: Average call duration and sentiment scores
Support insights: Identify usage patterns and issues

Real-World Scenarios:

Admin sees tenant approaching limit → proactively offer upgrade
Customer views their dashboard → sees call volume trends
Billing system queries stats → generates monthly invoice
Support team checks stats → troubleshoots customer issues

GET

tenants

{tenant_id}

stats

Get Tenant Stats

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/tenants/{tenant_id}/stats', 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/tenants/{tenant_id}/stats",
  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/tenants/{tenant_id}/stats"

	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/tenants/{tenant_id}/stats")

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

Response

Successful Response

Get Tenant Stats

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/tenants/{tenant_id}/stats', 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/tenants/{tenant_id}/stats",
  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/tenants/{tenant_id}/stats"

	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/tenants/{tenant_id}/stats")

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

Get Tenant Stats

Authorizations

Path Parameters

Response