Get ledger dashboard metrics

Returns, for the window, the total number of transactions, the count of each status the ledger knows, and the settled volume per asset. Volume sums transaction.amount over SETTLED transactions only — status APPROVED, the only status whose transactions moved money — and is reported PER ASSET with no cross-asset total, because adding two assets together does not produce money. Amounts are exact decimal strings whose scale is not normative; format them with the asset’s own exponent and never parse them as a binary float. volumeByAsset is the GROSS settled amount: every settled leg inside the window, reversal legs included. reversalsByAsset is the part of it made of reversal legs, same window and same settled filter. A true net is NOT derivable from the two alone, because it depends on whether each reversed original also falls inside the window; a consumer that needs net reads the transactions.

GET /v1/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/metrics

Get ledger dashboard metrics

cURL

curl --request GET \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/dashboard/metrics \
  --header 'Authorization: Bearer <token>'

200

{
  "byStatus": {},
  "reversalsByAsset": [
    {
      "amount": "41000.00",
      "asset": "BRL",
      "transactions": 128
    }
  ],
  "total": 1420,
  "updatedAt": "2023-11-07T05:31:56Z",
  "volumeByAsset": [
    {
      "amount": "41000.00",
      "asset": "BRL",
      "transactions": 128
    }
  ],
  "windowEnd": "2023-11-07T05:31:56Z",
  "windowStart": "2023-11-07T05:31:56Z"
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

organization_id · string · requerido

Organization ID (UUID)

ledger_id · string · requerido

Ledger ID (UUID)

Parámetros de consulta

period · string

Relative window: 7d, 30d or 90d (default: 30d). Mutually exclusive with start_date/end_date.

start_date · string

Window start (RFC3339, inclusive). Requires end_date. Mutually exclusive with period.

end_date · string

Window end (RFC3339, exclusive). Requires start_date. The window may not exceed 90 days.

Respuesta

200

application/json

OK

byStatus · object · requerido

Show child attributes

reversalsByAsset · object[] | null · requerido

The part of the gross volume made of reversal legs: settled transactions inside the window whose parent_transaction_id is set, per asset. A true net is not derivable from volume and reversals alone, because it depends on whether each reversed original also falls inside the window.

Show child attributes

total · integer<int64> · requerido

Ejemplo:

1420

updatedAt · string<date-time> · requerido

volumeByAsset · object[] | null · requerido

Show child attributes

windowEnd · string<date-time> · requerido

windowStart · string<date-time> · requerido