PolicyEffectivenessPreviewDto

PolicyEffectivenessPreviewDto
PolicyEffectivenessPreviewDto

Policy effectiveness preview metrics

JSON Example
{
    "policies": 0,
    "unpublishedFlagged": 0,
    "groupsPendingFlagged": 0,
    "groupsWithoutPolicy": 0,
    "pendingSync": 0,
    "syncErrors": 0,
    "notReporting": 0,
    "topPolicies": [
        {
            "policyId": 0,
            "name": "string",
            "matchedEvents": 0
        }
    ],
    "noMatchedRule": 0,
    "matchedButUnattributed": 0,
    "totalEvents": 0,
    "asOf": "string",
    "windowStart": "string",
    "windowEnd": "string"
}
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

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