Get ledger dashboard volume series

Returns one point per UTC calendar day the window TOUCHES, including days with no transactions, which are present with transactions 0 and an empty byAsset. A window is half-open and snaps to the minute rather than to midnight, so a 7d window opened mid-afternoon returns EIGHT points. Each point’s transactions counts every status; its byAsset applies the same settled rule as /metrics. Summing the points reproduces /metrics exactly, and is likewise GROSS of reversals.

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

Get ledger dashboard volume series

cURL

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

200

{
  "points": [
    {
      "byAsset": [
        {
          "amount": "41000.00",
          "asset": "BRL",
          "transactions": 128
        }
      ],
      "date": "2026-09-19",
      "transactions": 212
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "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

points · object[] | null · requerido

Show child attributes

updatedAt · string<date-time> · requerido

windowEnd · string<date-time> · requerido

windowStart · string<date-time> · requerido