> ## Documentation Index
> Fetch the complete documentation index at: https://hevninc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Transaction volume breakdown

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



## OpenAPI

````yaml /openapi.json get /api/v1/transactions/breakdown
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers:
  - url: https://api.hevn.finance
    description: Production
security: []
paths:
  /api/v1/transactions/breakdown:
    get:
      tags:
        - Transactions
      summary: Transaction volume breakdown
      description: >-
        Volume + count grouped by tag or type, with the same filters as the
        list.
      operationId: get_transactions_breakdown_api_v1_transactions_breakdown_get
      parameters:
        - name: groupBy
          in: query
          required: true
          schema:
            $ref: '#/components/schemas/TransactionGroupBy'
            description: Group by tag or type
          description: Group by tag or type
        - name: type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated transaction types
            title: Type
          description: Comma-separated transaction types
        - name: incomeOnly
          in: query
          required: false
          schema:
            anyOf:
              - type: boolean
              - type: 'null'
            title: Incomeonly
        - name: tag
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated tags
            title: Tag
          description: Comma-separated tags
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated unified statuses
            title: Status
          description: Comma-separated unified statuses
        - name: contactId
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated contact UUIDs
            title: Contactid
          description: Comma-separated contact UUIDs
        - name: bank_account_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated bank account UUIDs
            title: Bank Account Id
          description: Comma-separated bank account UUIDs
        - name: bankAccountId
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated bank account UUIDs
            title: Bankaccountid
          description: Comma-separated bank account UUIDs
        - name: cardId
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Comma-separated Card UUIDs
            title: Cardid
          description: Comma-separated Card UUIDs
        - name: fromDate
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: Fromdate
        - name: toDate
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            title: Todate
        - name: q
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              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.
            title: Q
          description: >-
            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.
        - name: x-api-key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionBreakdownResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    TransactionGroupBy:
      type: string
      enum:
        - tag
        - type
      title: TransactionGroupBy
      description: Field to group breakdown analytics by.
    TransactionBreakdownResponse:
      properties:
        groupBy:
          $ref: '#/components/schemas/TransactionGroupBy'
        items:
          items:
            $ref: '#/components/schemas/TransactionBreakdownItem'
          type: array
          title: Items
      type: object
      required:
        - groupBy
        - items
      title: TransactionBreakdownResponse
      description: >-
        Volume + count grouped by tag or type, with the same filters as the
        list.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    TransactionBreakdownItem:
      properties:
        key:
          type: string
          title: Key
        volumeUsd:
          type: number
          title: Volumeusd
        count:
          type: integer
          title: Count
      type: object
      required:
        - key
        - volumeUsd
        - count
      title: TransactionBreakdownItem
      description: One bucket in a breakdown — volume + count for a tag/type value.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
      x-default: Bearer <token>

````