Analyze transaction flow patterns
Changed onScans all transactions in a ledger, discovers flow patterns by normalizing account addresses, and returns statistics per flow type including temporal distribution and volume metrics. Requires ledger:read scope.
Request
- Base URLhttp://localhost:9000
- URLhttp://localhost:9000/v3/{ledgerName}/analyze-transactions
- Auth
- HTTP bearer
- or none
Path parameters
Name of the ledger
Query parameters
Max distinct children before classifying as variable (0 = default 10)
Headers
Read consistency. linearizable (the default) runs a Raft ReadIndex barrier and waits for the receiving node to apply up to it. stale serves the read from the receiving node's own store, with no barrier and no forwarding to the leader, so the answer may lag the leader. Matching ignores case and surrounding whitespace. An unknown value, or a repeated or comma-joined header, returns 400 INVALID_REQUEST on every /v3 route, writes included; a valid value has no effect on writes. The gRPC equivalent is the x-consistency request metadata.
Render all response Uint256, BigUint and SignedBigInt values as canonical decimal strings, regardless of business meaning, including posting amounts, volume input/output and balances. Ordinary integer IDs/counts, metadata and explicitly string-encoded counters keep their existing representation. Case-insensitive true, yes, y and 1 enable this option, matching Ledger v2. Whitespace is not trimmed. Omission and every other value retain JSON number tokens. This affects only this response, including nested objects, maps, arrays, transaction/log/cursor and bulk results. Request decoding is unchanged.
Response
Analysis completed successfully
Changes
- info
api operation id
analyzeTransactionsremoved and replaced withv3AnalyzeTransactions
- info
- breaking
response property
data/flowPatterns/items/volumeStats/items/averageVolumelist-of-types was widened by adding typesintegerto media typeapplication/jsonof response200 - breaking
response property
data/flowPatterns/items/volumeStats/items/maxVolumelist-of-types was widened by adding typesintegerto media typeapplication/jsonof response200 - breaking
response property
data/flowPatterns/items/volumeStats/items/minVolumelist-of-types was widened by adding typesintegerto media typeapplication/jsonof response200 - breaking
response property
data/flowPatterns/items/volumeStats/items/totalVolumelist-of-types was widened by adding typesintegerto media typeapplication/jsonof response200 - info
added the new optional
headerrequest parameterFormance-Bigint-As-String
- breaking