List match runs

Use this endpoint to retrieve all match runs for a specific reconciliation context. The results are sorted by creation time descending.

GET /v1/matching/contexts/{contextId}/runs

List match runs

cURL

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

200

Example

{
  "hasMore": true,
  "items": [
    {
      "contextId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2025-01-15T10:30:00Z",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "mode": "DRY_RUN",
      "startedAt": "2025-01-15T10:30:00Z",
      "status": "COMPLETED",
      "updatedAt": "2025-01-15T10:30:00Z",
      "completedAt": "2025-01-15T10:35:00Z",
      "failureReason": "no matching rules found",
      "ruleStats": [
        {
          "matched": 42,
          "priority": 1,
          "ruleId": "550e8400-e29b-41d4-a716-446655440000",
          "type": "EXACT"
        }
      ],
      "stats": {}
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

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

limit · integer<int64> · predeterminado: 20

The maximum number of items to include in the response. Maximum number of records to return

Rango requerido: 1 <= x <= 200

cursor · string

The cursor value for retrieving the next page of results. Opaque pagination cursor

sort_order · enum<string>

The order used to sort the results. Sort order

Opciones disponibles: asc, desc

Respuesta

200

application/json

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

hasMore · boolean · requerido

Ejemplo:

true

items · object[] | null · requerido

Page of match runs

Maximum array length: 200

Show child attributes

limit · integer<int64> · requerido

Rango requerido: 1 <= x <= 200

Ejemplo:

20

nextCursor · string

Ejemplo:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Ejemplo:

"eyJpZCI6IjEyMiJ9"