---
title: "Get dashboard summary with scope-aware KPI metrics"
method: GET
path: "/api/v1/dashboard/summary"
tags: ["Dashboard"]
---

# Get dashboard summary with scope-aware KPI metrics

`GET /api/v1/dashboard/summary`

Get dashboard summary with scope-aware KPI metrics

## Query parameters

- `period` union — Time period for KPI metrics (default: 30d)
  - '30d'
  - '60d'
  - 'all'

## Response `200`

Success

- DashboardSummaryResponse
  - `success` boolean, required — Indicates if the request was successful
  - `data` object, required
    - `scope` union, required — The resolved scope for this dashboard response
      - 'global'
      - 'partner'
      - 'merchant'
    - `period` union, required — The time period for this dashboard response
      - '30d'
      - '60d'
      - 'all'
    - `period_days` integer, nullable, required — Number of days in the current period (null for all-time)
    - `comparison_period` object
      - `start` string, date-time, required — Start of the comparison period
      - `end` string, date-time, required — End of the comparison period
    - `partners` object
      - `total` integer, required — All-time total count
      - `new_in_period` integer — New entities in the selected period (omitted for all-time)
    - `merchants` object
      - `total` integer, required — All-time total count
      - `new_in_period` integer — New entities in the selected period (omitted for all-time)
    - `transactions` object, required
      - `count` integer, required — Transaction count in current period
      - `previous_count` integer — Transaction count in previous period (omitted for all-time)
    - `volume_by_currency` object[], required
      - `currency` string, required — ISO 4217 currency code
      - `amount` string, required — Current period decimal amount
      - `previous_amount` string — Previous period decimal amount (omitted for all-time)
    - `fees_by_currency` object[], required
      - `currency` string, required — ISO 4217 currency code
      - `amount` string, required — Current period decimal amount
      - `previous_amount` string — Previous period decimal amount (omitted for all-time)
    - `next_payout_by_currency` object[], required
      - `currency` string, required — ISO 4217 currency code
      - `amount` string, required — Decimal amount as string (e.g. "1234.56")

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/banqzinc/apis/quidkey-api.md) · [All operations](https://skmtc.net/banqzinc/apis/quidkey-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/banqzinc/quidkey-api/revisions/f86d2bdbcb08/schema)