Dashboard Operations Get Top Matched Rules
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.
Time window counted back from now (default: 24h)
24h
Maximum number of Rules returned (default: 5, max: 10)
5
200 OK successful response envelope. The rules with the most matching events in the window
{
"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
}
]
}
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 given7d: The last 7 days30d: The last 30 days
Inclusive window start (UTC)
Inclusive window end (UTC)
Time the ranking was computed (UTC)
Applied item limit
Ranked Rules, most matched first (ties by Rule identifier), at most limit entries
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
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 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)
"ApiErrorResponse Object"
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
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 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail
"ApiErrorResponse Object"
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.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/dashboard/top-matched-rules