Reports Operations Get Policy Effectiveness Preview

Reports Operations Get Policy Effectiveness Preview
Policy effectiveness preview metrics

Returns configuration health and top policy match volume metrics. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/reports/policy-effectiveness/preview
COPY
Query Parameters
range
Optional

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.

range example
7d

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The configuration health and the top policy match volume metrics for the range

Returns PolicyEffectivenessPreviewDto of type(s) application/json
{
    "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"
}
integer As int64 As int64
policies
Required  

Number of policies stored; not limited to the window

integer As int64 As int64
unpublishedFlagged
Required  

Number of policies flagged as having unpublished changes; not limited to the window

integer As int64 As int64
groupsPendingFlagged
Required  

Number of Security Groups flagged as having pending changes; not limited to the window

integer As int64 As int64
groupsWithoutPolicy
Required  

Number of Security Groups with no policy assigned; not limited to the window

integer As int64 As int64
pendingSync
Required  

Number of non-deleted agents in a Group whose policy sync state is PENDING; not limited to the window

integer As int64 As int64
syncErrors
Required  

Number of non-deleted agents in a Group whose policy sync state is ERROR; not limited to the window

integer As int64 As int64
notReporting
Required  

Number of non-deleted agents in a Group that have no agent state yet; not limited to the window

array of object
topPolicies
Required  

Up to 5 policies with the most matched Events in the window, by count descending, then name, then identifier

integer As int64 As int64
noMatchedRule
Required  

Number of Events in the window that matched no Rule

integer As int64 As int64
matchedButUnattributed
Required  

Number of Events in the window that matched a Rule that belongs to no policy bound to the Event's Group

integer As int64 As int64
totalEvents
Required  

Number of all Events ingested in the window

string As date-time As date-time
asOf
Required  

UTC instant the counts were read, taken at query time (slightly after windowEnd)

string As date-time As date-time
windowStart
Required  

UTC start of the window: windowEnd minus 24 hours, 7 days or 30 days

string As date-time As date-time
windowEnd
Required  

UTC end of the window: the time the request was handled


400

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."

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 Unauthenticated 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
{
    "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.


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/reports/policy-effectiveness/preview