Reports Operations Export Policy Effectiveness
Streams a CSV export of policy match volume and configuration health. The response is text/csv with charset UTF-8, sent as an attachment named policy-effectiveness-report-YYYY-MM-DD.csv (the date is the current UTC date) with caching disabled. The first line is the column header row, in this order, policy_id, policy_name, description, has_unpublished_changes, groups_bound, rule_count, matched_events. There is one row for every policy regardless of the range, ordered by matched_events descending and then by policy name, and the range only limits matched_events to events ingested inside the window that matched one of the policy's rules. The policy_name and description columns are always enclosed in double quotes with embedded quotes doubled, and a text value whose first non-space character is =, +, -, @, tab, CR or LF is prefixed with a single quote to neutralise spreadsheet formulas. The range query parameter accepts 24h, 7d or 30d and defaults to 7d, and any other value is rejected with 400 INVALID_RANGE. There is no row limit. Requires the ADMIN or SECURITY_OPERATOR role (the AUDITOR role receives 403, although it may use the preview). Every export attempt is audited (REPORT_EXPORTED on success, REPORT_EXPORT_FAILED on a denied or failed attempt).
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 CSV file stream. The CSV of policy match volume and configuration health, sent as an attachment named policy-effectiveness-report-YYYY-MM-DD.csv
"policy_id,policy_name,description,has_unpublished_changes,groups_bound,rule_count,matched_events\n1,\"Baseline Policy\",\"Default protections for every group\",false,2,14,57\n2,\"Production Policy\",\"Stricter rules for production hosts\",true,1,6,31\n"
400 Bad Request: INVALID_RANGE when range is not a supported value (24h, 7d or 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: FORBIDDEN when the signed-in role is not allowed to call this operation; 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
{
"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.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/reports/policy-effectiveness/export