Transaction volume breakdown over time

Volume + count grouped by tag or type, split into time buckets across the fromDate..toDate range. Granularity is auto-picked: >6 months → month, >30 days → week, otherwise day. Empty periods are returned as zero-filled buckets so the frontend gets a complete x-axis. Same filter set as /transactions and /transactions/breakdown. fromDate and toDate are required.

GET /api/v1/transactions/breakdown/series

Transaction volume breakdown over time

cURL

curl --request GET \
  --url https://api.hevn.finance/api/v1/transactions/breakdown/series \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.hevn.finance/api/v1/transactions/breakdown/series"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.hevn.finance/api/v1/transactions/breakdown/series', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "buckets": [
    {
      "bucketStart": "2023-11-07T05:31:56Z",
      "bucketEnd": "2023-11-07T05:31:56Z",
      "items": [
        {
          "key": "<string>",
          "volumeUsd": 123,
          "count": 123
        }
      ]
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · default: Bearer <token> · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-api-key · string | null

Query Parameters

groupBy · enum<string> · required

Group by tag or type

Available options: tag, type

type · string | null

Comma-separated transaction types

incomeOnly · boolean | null

tag · string | null

Comma-separated tags

status · string | null

Comma-separated unified statuses

contactId · string | null

Comma-separated contact UUIDs

bank_account_id · string | null

Comma-separated bank account UUIDs

bankAccountId · string | null

Comma-separated bank account UUIDs

cardId · string | null

Comma-separated Card UUIDs

fromDate · string<date-time> | null

toDate · string<date-time> | null

q · string | null

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.

Response

200

application/json

Successful Response

Time-bucketed volume + count grouped by tag or type.

Granularity is auto-picked from the fromDate/toDate range: months for ranges longer than 6 months, weeks for >30 days, days otherwise. The response always includes every bucket in the range (zero-filled when empty) so the frontend gets a complete x-axis.

groupBy · enum<string> · required

Field to group breakdown analytics by.

Available options: tag, type

granularity · enum<string> · required

Time bucket size for the breakdown series.

Available options: day, week, month

buckets · TransactionBreakdownSeriesBucket · object[] · required

Show child attributes