Skip to main content
GET
Get dashboard summary
← Partner API Reference Two endpoints provide 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.
All Partner API requests use X-Auth-ID and X-Auth-Token headers. See Authentication for details.

Overview

Partner Dashboard

Returns a high-level snapshot of your partner account, including total active customer accounts, combined wallet balances, total calls today, and platform-level status indicators.

Response fields

Call roll-up fields

calls, each side of traffic (inbound, outbound), and each product in by_product (sip_trunking, voice_api) carry the same four fields.

accounts.customers[] fields

time_series[] fields

partner fields

The partner object is your partner profile. See Partner Profile for what each field controls.

Errors

See Error Handling for the shared error format.
To find customers at risk of running out of balance, there is no single “low balance” field - page through GET /accounts (each row carries cash_credits) or call Get Customer Balance per account, then recharge proactively so calls don’t start failing.

Partner Analytics

Returns aggregated call analytics across all 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 trend analysis.

Query Parameters

Default - Last 30 Days

Custom Date Range

Response

The analytics response has the same top-level fields as the dashboard: partner, period, accounts, total_balance, currency, calls, traffic, by_product, and time_series. See Response fields above for what each one contains. Here, period reflects the from_date / to_date window you asked for.

Use Cases

  • Monthly billing cycle - Pull analytics for the billing month to calculate total usage (calls.total_cost, calls.total_minutes), generate invoices, and reconcile against your transaction ledger.
  • Answer-rate analysis - Track calls.answered_calls / calls.total_calls over time (or per-day via time_series) to spot network quality or configuration problems.
  • Inbound vs. outbound split - Use traffic.inbound vs traffic.outbound to understand your base - outbound-heavy customers have different pricing and capacity needs than inbound-heavy ones.
  • Product mix - Use by_product to see how usage splits between sip_trunking and voice_api across your ecosystem.

Authorizations

X-Auth-ID
string
header
required

Your Vobiz account Auth ID

X-Auth-Token
string
header
required

Your Vobiz account Auth Token

Response

Dashboard summary

partner
object
required
period
object
required
accounts
object
required
total_balance
string
required
currency
string
required
calls
object
required
traffic
object
required
by_product
object
required
time_series
object[]
required