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

{
  "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

Generate a full system prompt from a short briefExpand a 1-2 sentence brief into a production-ready voice-agent system prompt. The frontend's "Generate" button hits this. The result is returned, not stored — the operator reviews/edits before posting it as `system_prompt` in the agent create/update payload.

Get Tenant Stats

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

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

Documentation Index

Authorizations

Path Parameters

Response