Skip to main content
POST
ListRuleMatches

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ruleIds
string<uuid>[]

Rules to report on. Empty returns every rule that currently categorises at least one check.

Maximum array length: 200
sampleSize
integer<int32> | null

How many check ids to return per rule as a sample. Defaults to 100, and may be 0 for counts only. The counts are always exact whatever this is set to.

Required range: 0 <= x <= 1000

Response

200 - application/json

Success

matches
object

Matches keyed by rule id. Rules that currently categorise nothing are absent.