Partner API

Dashboard & Analytics

Two endpoints give you aggregated intelligence across your entire reseller ecosystem — a live dashboard summary for high-level health checks, and a flexible analytics endpoint for date-range performance reporting.

Overview

Endpoint	What it returns	Best for
/dashboard	Live counts, balances, today's call volume	Main UI landing page, health checks
/analytics	Aggregated call metrics, cost, top spenders	Billing cycles, customer reports, trend analysis

Partner Dashboard

GEThttps://api.vobiz.ai/api/v1/partner/dashboard

Returns a high-level snapshot of your partner account — total active customer accounts, combined wallet balances, total calls today, and platform-level status indicators. Designed to power a dashboard landing page.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/dashboard" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "active_accounts": 47,
  "total_balance": 284500.00,
  "currency": "INR",
  "calls_today": 1284,
  "calls_this_month": 38420,
  "total_spend_this_month": 17289.00,
  "accounts_low_balance": 3,
  "accounts_suspended": 1
}

accounts_low_balance: Count of customers with balance below a configured threshold. Use this to proactively recharge customer wallets before they run out and calls start failing.

Partner Analytics

GEThttps://api.vobiz.ai/api/v1/partner/analytics

Returns aggregated call analytics across all your customer accounts. Defaults to the last 30 days. Pass from_date and to_date for a custom window. Use for billing cycle audits, identifying top-spending customers, and call volume trends.

Authentication Required:

• X-Auth-ID: Your Partner ID
• X-Auth-Token: Your secret API token
• Accept: application/json

Query Parameters

Parameter	Type	Required	Description
from_date	string	Optional	Start date in YYYY-MM-DD format. Defaults to 30 days ago.
to_date	string	Optional	End date in YYYY-MM-DD format. Defaults to today.

Default — Last 30 Days

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/analytics" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

Custom Date Range

cURL

curl -X GET \
  "https://api.vobiz.ai/api/v1/partner/analytics?from_date=2026-01-01&to_date=2026-03-31" \
  -H "X-Auth-ID: {your_partner_id}" \
  -H "X-Auth-Token: {your_auth_token}" \
  -H "Accept: application/json"

200 OK

{
  "period": {
    "from": "2026-01-01",
    "to": "2026-03-31"
  },
  "totals": {
    "total_calls": 124830,
    "answered_calls": 118204,
    "failed_calls": 6626,
    "total_duration_seconds": 7482600,
    "total_cost": 336717.00,
    "currency": "INR"
  },
  "by_direction": {
    "inbound": { "calls": 61200, "cost": 165840.00 },
    "outbound": { "calls": 63630, "cost": 170877.00 }
  },
  "top_customers": [
    { "auth_id": "MA_48149cf4", "name": "Credresolve", "calls": 18420, "cost": 82890.00 },
    { "auth_id": "MA_99ab12c3", "name": "Acme Outbound", "calls": 15300, "cost": 68850.00 }
  ]
}

Analytics Response Fields

Field	Description
period.from / to	Actual date range of the response (reflects defaults if params were omitted)
totals.total_calls	Total call attempts across all customers in the period
totals.answered_calls	Calls that were successfully answered and connected
totals.failed_calls	Calls that failed (busy, no answer, network error)
totals.total_duration_seconds	Combined call duration in seconds across all customers
totals.total_cost	Total charges across all customer accounts in the period
by_direction	Breakdown of totals by inbound vs. outbound call direction
top_customers	Array of highest-spending customers by total cost, descending

Use Cases

Monthly billing cycle

Pull analytics for the billing month to calculate total usage, generate invoices, and reconcile with your ledger.

Identify top spenders

Use top_customers to find your highest-revenue accounts for account management prioritization.

Call failure analysis

Monitor failed_calls / total_calls ratio over time to identify network quality issues or configuration problems.

Inbound vs. outbound split

Use by_direction to understand your customer base — outbound-heavy customers have different pricing and capacity needs than inbound-heavy ones.

Profile

Customer Accounts