# Overview Retrieve a high-level summary of active calls, live agents, tool configurations, pending schedules, webhooks, and wallet balance.

<div class="endpoint-path">
  <span class="badge badge-get">GET</span>
  <code>/v1/overview</code>
</div>

## Authorizations

<div class="param-row">
  <div class="param-name">X-API-Key</div>
  <div class="param-badges">
    <span class="badge-type">string</span>
    <span class="badge-loc">header</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Voice Platform authentication secret token key.</div>
</div>

## Response
<span class="response-status-info">200 - application/json</span>

<div class="param-row">
  <div class="param-name">activeCalls</div>
  <div class="param-badges">
    <span class="badge-type">integer</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Number of voice calls currently in progress.</div>
</div>

<div class="param-row">
  <div class="param-name">liveAgents</div>
  <div class="param-badges">
    <span class="badge-type">integer</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Number of active voice agent configurations.</div>
</div>

<div class="param-row">
  <div class="param-name">metrics</div>
  <div class="param-badges">
    <span class="badge-type">array&lt;object&gt;</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">List of core performance indicators and contextual system health reports.</div>
</div>

<div class="param-row">
  <div class="param-name">walletBalancePaise</div>
  <div class="param-badges">
    <span class="badge-type">integer</span>
    <span class="badge-req">required</span>
  </div>
  <div class="param-desc">Remaining platform credits in Indian Paise (e.g. 500000 = ₹5,000.00).</div>
</div>

curl --request GET \
  --url https://api.branofy.cloud/v1/overview \
  --header 'X-API-Key: your_voice_api_secret_key'

<div class="response-preview">
  <div class="response-header">
    <span>Response</span>
    <span class="status-200">200 OK</span>
  </div>

{
  "activeCalls": 3,
  "liveAgents": 5,
  "metrics": [
    {
      "label": "Call Success Rate",
      "tone": "success",
      "value": "98.5%"
    }
  ],
  "pendingSchedules": 2,
  "totalApiKeys": 4,
  "totalTools": 8,
  "totalWebhooks": 3,
  "walletBalancePaise": 500000
}

</div>