Dashboard Operations Get Top Matched Rules

Dashboard Operations Get Top Matched Rules
Most matched Rules in a time window (Administrator, Security Operator or Auditor only)

matchCount is the number of persisted Event rows attributed to the Rule in the window, not distinct alerts and not distinct hypervisors. Ordered by matchCount DESC, ruleId ASC.

Request
URI
GET
https://{api_host}/api/v1/dashboard/top-matched-rules
COPY
Query Parameters
window
Optional
Constraints: default: 24h

Time window counted back from now (default: 24h)

window example
24h
integer
limit
Optional
Constraints: minimum: 1 maximum: 10 default: 5

Maximum number of Rules returned (default: 5, max: 10)

limit example
5

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The rules with the most matching events in the window

Returns TopMatchedRulesDto of type(s) application/json
{
    "window": "24h",
    "windowStart": "2026-01-14T10:00:00Z",
    "windowEnd": "2026-01-15T10:00:00Z",
    "asOf": "2026-01-15T10:00:00Z",
    "limit": 5,
    "items": [
        {
            "ruleId": 12,
            "ruleName": "Block Unapproved Scripts",
            "ruleAction": "BLOCK",
            "ruleDeleted": false,
            "matchCount": 42
        },
        {
            "ruleId": 7,
            "ruleName": "Audit Shell Spawn",
            "ruleAction": "AUDIT",
            "ruleDeleted": false,
            "matchCount": 17
        },
        {
            "ruleId": 31,
            "ruleName": "Require MFA for SSH",
            "ruleAction": "MFA_REQUIRED",
            "ruleDeleted": false,
            "matchCount": 9
        }
    ]
}
string
window
Required  

Time window for the top-matched-Rules ranking, counted back from the request time

  • 24h: The last 24 hours; the default when no window is given
  • 7d: The last 7 days
  • 30d: The last 30 days
Enumeration: 24h, 7d, 30d
string As date-time As date-time
windowStart
Required  

Inclusive window start (UTC)

string As date-time As date-time
windowEnd
Required  

Inclusive window end (UTC)

string As date-time As date-time
asOf
Required  

Time the ranking was computed (UTC)

integer As int32 As int32
limit
Required  

Applied item limit

array of object
items
Required  

Ranked Rules, most matched first (ties by Rule identifier), at most limit entries


400

400 Bad Request: INVALID_ARGUMENT when window is not 24h, 7d or 30d, or limit is not a number or is outside 1 to 10

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


500

500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/dashboard/top-matched-rules