Get transaction, reward, or traffic history

get

https://example.com/api/v2/dashboard/{party}/timeseries

Groups the selected data by time period, includes summary statistics, and can compare it with the preceding period.

Path Params

party

string

required

Canton party identifier.

Query Params

seriesType

string

Series to return: transactions, validator-rewards, app-rewards, issued-rewards, traffic-buys, or traffic-costs. Defaults to transactions.

timezone

string

Timezone used to group results by time. Defaults to UTC.

filterByParty

boolean

For traffic-costs, scope costs to the party instead of the whole node. Defaults to true.

compare

boolean

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

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