Get source breakdown

Use this endpoint to retrieve a breakdown of reconciliation metrics by source for a specific context and date range. Shows match rates, transaction counts, and unmatched amounts per source.

GET /v1/reports/contexts/{contextId}/dashboard/source-breakdown

Get source breakdown

cURL

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

200

Example

{
  "sources": [
    {
      "currency": "USD",
      "matchRate": 95,
      "matchedTransactions": 4750,
      "sourceId": "550e8400-e29b-41d4-a716-446655440000",
      "sourceName": "Primary Bank Account",
      "totalAmount": "500000.00",
      "totalTransactions": 5000,
      "unmatchedAmount": "25000.00",
      "unmatchedTransactions": 250
    }
  ]
}

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

Source breakdown metrics

sources · object[] | null · requerido

Per-source reconciliation statistics for the window.

Show child attributes