Skip to main content
POST
Simulate a match rule against a context (read-only dry run)

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
contextId
string<uuid>
requerido

Context ID whose transactions the rule is simulated against

rule
object

Inline candidate rule to preview. Provide this OR ruleId, not both.

ruleId
string<uuid>

Identifier of an existing configured rule to preview. Provide this OR rule, not both.

sampleLimit
integer<int64>
predeterminado:25

Maximum number of would-match pairs to return in the sample

Rango requerido: 1 <= x <= 200

Respuesta

OK

matchedGroups
integer<int64>
requerido

Number of 1:1 groups the rule would form across the context

Rango requerido: x >= 0
Ejemplo:

12

ruleType
string
requerido

Strategy of the previewed rule

Ejemplo:

"EXACT"

sample
object[] | null
requerido

Bounded sample of would-match pairs (highest score first)

Maximum array length: 200
sampleTruncated
boolean
requerido

Whether matchedGroups exceeds the returned sample length

Ejemplo:

false

unmatchedLeft
integer<int64>
requerido

Left-side transactions that would remain unmatched

Rango requerido: x >= 0
Ejemplo:

3

unmatchedRight
integer<int64>
requerido

Right-side transactions that would remain unmatched

Rango requerido: x >= 0
Ejemplo:

5

ruleId
string

Identifier of the previewed rule. Empty for an inline candidate rule (not persisted).

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"