Get match run

Use this endpoint to retrieve the details of a specific match run by its identifier. The response includes status, timing, and aggregate statistics.

GET /v1/matching/runs/{runId}

Get match run

cURL

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

200

{
  "completedAt": "<string>",
  "contextId": "<string>",
  "createdAt": "<string>",
  "failureReason": "<string>",
  "id": "<string>",
  "startedAt": "<string>",
  "stats": {},
  "updatedAt": "<string>"
}

Authorizations

Authorization · string · header · required

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

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

Path Parameters

runId · string · required

Run ID

Query Parameters

contextId · string · required

Context ID

Response

200

application/json

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

completedAt · string

contextId · string

createdAt · string

failureReason · string

id · string

mode · enum<string>

Execution mode for a matching run

Available options: DRY_RUN, COMMIT

startedAt · string

stats · object

Show child attributes

status · enum<string>

Lifecycle status of a matching run

Available options: PROCESSING, COMPLETED, FAILED

updatedAt · string