Get volume statistics

Use this endpoint to retrieve transaction volume statistics for a reconciliation context within the specified date range.

GET /v1/reports/contexts/{contextId}/dashboard/volume

Get volume statistics

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/volume \
  --header 'Authorization: Bearer <token>'

200

Example

{
  "matchedAmount": "1180000.00",
  "matchedTransactions": 11800,
  "periodEnd": "2025-01-31T23:59:59Z",
  "periodStart": "2025-01-01T00:00:00Z",
  "totalAmount": "1250000.00",
  "totalTransactions": 12500,
  "unmatchedAmount": "70000.00",
  "unmatchedCount": 700
}

Autorizaciones

Authorization · string · header · requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id · string

A unique identifier for tracing the request across services.

Parámetros de ruta

contextId · string<uuid> · requerido

The unique identifier of the reconciliation context. Context ID

Parámetros de consulta

date_from · string<date>

Start date (YYYY-MM-DD) Start date (YYYY-MM-DD), inclusive. Optional: defaults to 30 days before date_to. Window may not exceed 90 days.

date_to · string<date>

End date (YYYY-MM-DD) End date (YYYY-MM-DD), inclusive. Optional: defaults to tomorrow (UTC). Window may not exceed 90 days.

source_id · string<uuid>

Source ID filter

Respuesta

200

application/json

Indicates that the request was successful and the response contains the expected data.

matchedAmount · string · requerido

Total monetary value of matched transactions, as a decimal string: an arithmetic sum across currencies, a money figure only when the window holds one currency.

Ejemplo:

"1180000.00"

matchedTransactions · integer<int64> · requerido

Number of transactions that were successfully matched.

Ejemplo:

11800

periodEnd · string<date-time> · requerido

Inclusive end of the reporting window (RFC 3339 timestamp, UTC).

Ejemplo:

"2025-01-31T23:59:59Z"

periodStart · string<date-time> · requerido

Inclusive start of the reporting window (RFC 3339 timestamp, UTC).

Ejemplo:

"2025-01-01T00:00:00Z"

totalAmount · string · requerido

Total monetary value of all transactions, as a decimal string: an arithmetic sum across currencies, a money figure only when the window holds one currency.

Ejemplo:

"1250000.00"

totalTransactions · integer<int64> · requerido

Total number of transactions in the reporting window.

Ejemplo:

12500

unmatchedAmount · string · requerido

Total monetary value of unmatched transactions, as a decimal string: an arithmetic sum across currencies, a money figure only when the window holds one currency (see unmatchedByCurrency).

Ejemplo:

"70000.00"

unmatchedCount · integer<int64> · requerido

Number of transactions left unmatched.

Ejemplo:

700