Get match rate statistics

Use this endpoint to retrieve match rate percentage and trend data for a reconciliation context within the specified date range.

GET /v1/reports/contexts/{contextId}/dashboard/match-rate

Get match rate statistics

cURL

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

200

Example

{ "matchRate": 94.4, "matchRateAmount": 94.4, "matchedCount": 11800, "totalCount": 12500, "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 · number<double> · requerido

Percentage of transactions matched by count (0-100).

Ejemplo:

94.4

matchRateAmount · number<double> · requerido

Percentage of transaction value matched by monetary amount (0-100).

Ejemplo:

94.4

matchedCount · integer<int64> · requerido

Number of matched transactions.

Ejemplo:

11800

totalCount · integer<int64> · requerido

Total number of transactions considered for the match rate.

Ejemplo:

12500

unmatchedCount · integer<int64> · requerido

Number of unmatched transactions.

Ejemplo:

700