Get all dashboard aggregates

Use this endpoint to retrieve combined dashboard aggregates including volume, match rate, and SLA statistics.

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

Get all dashboard aggregates

cURL

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

200

Example

{
  "matchRate": {
    "matchRate": 94.4,
    "matchRateAmount": 94.4,
    "matchedCount": 11800,
    "totalCount": 12500,
    "unmatchedCount": 700
  },
  "sla": {
    "averageResolutionMs": 3600000,
    "pendingOverdue": 2,
    "pendingWithinSLA": 2,
    "resolvedLate": 3,
    "resolvedOnTime": 35,
    "slaComplianceRate": 83.3,
    "totalExceptions": 42
  },
  "unmatchedByCurrency": [
    {
      "amount": "25000.00",
      "currency": "USD",
      "transactionCount": 250
    }
  ],
  "updatedAt": "2025-01-15T10:30:00Z",
  "volume": {
    "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.

matchRate · object · requerido

Match rate statistics for the window.

Show child attributes

sla · object · requerido

SLA compliance statistics for the window.

Show child attributes

unmatchedByCurrency · object[] · requerido

Unreconciled exposure split by currency; the amounts sum to volume.unmatchedAmount. Empty when no transaction in the window is UNMATCHED or PENDING_REVIEW; always an array, never null. volume.unmatchedAmount is the engine's arithmetic sum of those amounts across currencies, so it is a meaningful money figure only when this split carries a single currency. Clients must not render it as money when the split names more than one currency.

Show child attributes

updatedAt · string<date-time> · requerido

Timestamp when these aggregates were computed (RFC 3339, UTC).

Ejemplo:

"2025-01-15T10:30:00Z"

volume · object · requerido

Transaction volume statistics for the window.

Show child attributes