Reports Operations Get Policy Effectiveness Preview
Returns configuration health and top policy match volume metrics. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.
Time window counted back from the request time: 24h, 7d or 30d (default 7d). Only these exact lowercase values are accepted; any other value, including an empty one, answers 400 INVALID_RANGE.
7d
200 OK successful response envelope. The configuration health and the top policy match volume metrics for the range
{
"policies": 3,
"unpublishedFlagged": 1,
"groupsPendingFlagged": 1,
"groupsWithoutPolicy": 0,
"pendingSync": 2,
"syncErrors": 0,
"notReporting": 1,
"topPolicies": [
{
"policyId": 1,
"name": "Baseline Policy",
"matchedEvents": 57
},
{
"policyId": 2,
"name": "Production Policy",
"matchedEvents": 31
}
],
"noMatchedRule": 12,
"matchedButUnattributed": 3,
"totalEvents": 118,
"asOf": "2026-01-15T10:00:01Z",
"windowStart": "2026-01-08T10:00:00Z",
"windowEnd": "2026-01-15T10:00:00Z"
}
Number of policies stored; not limited to the window
Number of policies flagged as having unpublished changes; not limited to the window
Number of Security Groups flagged as having pending changes; not limited to the window
Number of Security Groups with no policy assigned; not limited to the window
Number of non-deleted agents in a Group whose policy sync state is PENDING; not limited to the window
Number of non-deleted agents in a Group whose policy sync state is ERROR; not limited to the window
Number of non-deleted agents in a Group that have no agent state yet; not limited to the window
Up to 5 policies with the most matched Events in the window, by count descending, then name, then identifier
Number of Events in the window that matched no Rule
Number of Events in the window that matched a Rule that belongs to no policy bound to the Event's Group
Number of all Events ingested in the window
UTC instant the counts were read, taken at query time (slightly after windowEnd)
UTC start of the window: windowEnd minus 24 hours, 7 days or 30 days
UTC end of the window: the time the request was handled
400 Bad Request: INVALID_RANGE when range is not exactly 24h, 7d or 30d (lowercase; an empty value, a different letter case or any alias is rejected; omitting range defaults to 7d); the message is "Unsupported time range provided. Valid values are 24h, 7d, 30d."
{
"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)
{
"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.
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/reports/policy-effectiveness/preview