---
title: "Transaction volume breakdown"
method: GET
path: "/api/v1/transactions/breakdown"
tags: ["Transactions"]
---

# Transaction volume breakdown

`GET /api/v1/transactions/breakdown`

Volume + count grouped by tag or type, with the same filters as the list.

## Query parameters

- `groupBy` 'tag' | 'type', required — Field to group breakdown analytics by.
- `type` string, nullable — Comma-separated transaction types
- `incomeOnly` boolean, nullable
- `tag` string, nullable — Comma-separated tags
- `status` string, nullable — Comma-separated unified statuses
- `contactId` string, nullable — Comma-separated contact UUIDs
- `bank_account_id` string, nullable — Comma-separated bank account UUIDs
- `bankAccountId` string, nullable — Comma-separated bank account UUIDs
- `cardId` string, nullable — Comma-separated Card UUIDs
- `fromDate` string, date-time, nullable
- `toDate` string, date-time, nullable
- `q` string, nullable — Free-text search across description, merchant, tag, hash/wallet, contact name, counterparty user, invoice contractor, IBAN, and exact amount. Min 2 chars; values shorter are ignored.

## Headers

- `x-api-key` string, nullable

## Response `200`

Successful Response

- TransactionBreakdownResponse — Volume + count grouped by tag or type, with the same filters as the list.
  - `groupBy` 'tag' | 'type', required — Field to group breakdown analytics by.
  - `items` TransactionBreakdownItem[], required
    - `key` string, required
    - `volumeUsd` number, required
    - `count` integer, required

## Other responses

- `422` — Validation Error

---

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