Count dashboard transactions

get

https://example.com/api/v2/dashboard/{party}/tx-count

Counts transactions using the same filters as the dashboard list and can compare them with the preceding period.

Path Params

party

string

required

Canton party identifier.

Query Params

compare

boolean

Include the preceding equal-duration period when both range bounds are valid. Defaults to false.

types

array of strings

Classification types to include; repeat the parameter for multiple values.

types

excludeTypes

array of strings

Classification types to exclude; cannot be combined with types.

excludeTypes

parties

array of strings

Counterparty addresses to include; repeat the parameter for multiple values.

parties

actorOnly

boolean

Restrict results to transactions where the requested party is an actor. Defaults to false.

text

string

Text to match in the transaction.

assetKind

string

Use 'canton_coin' to select Canton Coin. This cannot be combined with an instrument pair.

instrumentAdmin

string

Private instrument administrator; must be supplied with instrumentId.

instrumentId

string

Private instrument identifier; must be supplied with instrumentAdmin.

from

date-time

Start of the requested period, included in results.

date-time

End of the requested period, excluded from results.

jwt

string

Ledger API JWT alternative to the jwt header.

nodeId

string

Configured validator-node identifier; defaults to the deployment default.

Headers

jwt

string

Ledger API JWT used to resolve the caller's party permissions.

nodeId

string

Configured validator-node identifier alternative to the nodeId query parameter.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

503Service is still starting