---
title: "Get dashboard summary"
method: GET
path: "/api/v1/partner/dashboard"
tags: ["Partner API"]
---

# Get dashboard summary

`GET /api/v1/partner/dashboard`

Aggregated partner metrics - total customers, active accounts, balance
held across the partner ecosystem, MTD revenue, etc.

## Response `200`

Dashboard summary

- object
  - `partner` object, required
    - `id` string, required
    - `account_id` integer, required
    - `name` string, required
    - `slug` string, required
    - `company` string, required
    - `auth_id` string, required
    - `email` string, required
    - `phone` string, required
    - `billing_model` string, required
    - `is_active` boolean, required
    - `is_verified` boolean, required
    - `max_accounts` integer, required
    - `can_create_accounts` boolean, required
    - `can_create_pricing_tiers` boolean, required
    - `can_view_cdrs` boolean, required
    - `can_transfer_balance` boolean, required
    - `default_pricing_tier_id` string, required
    - `account_count` integer, required
    - `balance` unknown, required
    - `created_at` string, required
    - `updated_at` string, required
  - `period` object, required
    - `from` string, required
    - `to` string, required
  - `accounts` object, required
    - `total` integer, required
    - `active` integer, required
    - `customers` object[], required
      - `auth_id` string, required
      - `name` string, required
      - `email` string, required
      - `phone` string, required
      - `is_active` boolean, required
      - `created_at` string, required
  - `total_balance` string, required
  - `currency` string, required
  - `calls` object, required
    - `total_calls` integer, required
    - `answered_calls` integer, required
    - `total_minutes` number, required
    - `total_cost` string, required
  - `traffic` object, required
    - `inbound` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` number, required
      - `total_cost` string, required
    - `outbound` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` number, required
      - `total_cost` string, required
  - `by_product` object, required
    - `sip_trunking` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` integer, required
      - `total_cost` string, required
    - `voice_api` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` number, required
      - `total_cost` string, required
  - `time_series` object[], required
    - `date` string, required
    - `total_calls` integer, required
    - `answered_calls` integer, required
    - `total_minutes` number, required
    - `total_cost` string, required
    - `inbound` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` number, required
    - `outbound` object, required
      - `total_calls` integer, required
      - `answered_calls` integer, required
      - `total_minutes` number, required

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) · [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vobiz/vobiz-api/revisions/863f08cd6737/schema)