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

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
contextId
string<uuid>
obrigatório

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>
padrão:25

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

Intervalo obrigatório: 1 <= x <= 200

Resposta

OK

matchedGroups
integer<int64>
obrigatório

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

Intervalo obrigatório: x >= 0
Exemplo:

12

ruleType
string
obrigatório

Strategy of the previewed rule

Exemplo:

"EXACT"

sample
object[] | null
obrigatório

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

Maximum array length: 200
sampleTruncated
boolean
obrigatório

Whether matchedGroups exceeds the returned sample length

Exemplo:

false

unmatchedLeft
integer<int64>
obrigatório

Left-side transactions that would remain unmatched

Intervalo obrigatório: x >= 0
Exemplo:

3

unmatchedRight
integer<int64>
obrigatório

Right-side transactions that would remain unmatched

Intervalo obrigatório: x >= 0
Exemplo:

5

ruleId
string

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

Exemplo:

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