API Reference
Log In
API Reference

Count the enforcement events matching a filter

Returns the counts behind the enforcement events tab's tiles for the same filter the list accepts: how many requests were blocked, how many a shadow-mode rule would have blocked, how many warning lines were crossed, how many a shadow-mode rule would have crossed, and how many distinct people or objects the matching events name. level and mode are accepted so one query string serves every endpoint on this resource, and are deliberately not applied to these counts: level defaults to HARD, so applying it would report zero warnings to every caller that never sent a level at all, and clicking a tile as a filter would zero the tiles beside it. Every other filter is applied, over the window resolved exactly as the list resolves it. distinctAffected is zero on a pooled cost control, which groups on nothing, and counts events whose dimension was never recorded, so it can be larger than the total on /affected, which needs both the value and the dimension before it can offer a row. resolvedSince and resolvedUntil carry the window these counts were actually taken over, which is not always the one that was asked for: an over-old since is moved forward rather than refused. This endpoint answers with its own object rather than with the paged envelope the list returns, so do not reach for the list's unwrapping helper here.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Revenium-generated identifier of the team to scope the counts

string

Optional ISO-8601 timestamp starting the date range, inclusive, resolved exactly as the list resolves it, so the counts and the rows cover one window

string

Optional ISO-8601 timestamp ending the date range, inclusive, resolved exactly as the list resolves it

string

Optional Revenium-generated identifier of a cost control. When supplied, only events produced by that rule are counted.

string
enum

Accepted and validated for query-string compatibility with the list, and deliberately not applied to these counts. See the endpoint description.

Allowed:
string
enum

Accepted and validated for query-string compatibility with the list, and deliberately not applied to these counts. See the endpoint description.

Allowed:
string

Optional free-text search, matched case-insensitively against the event's details string, exactly as on the list

string

Optional exact match on the affected person or object. Send back the value this resource returned, hashed for an ORG_UNIT group and raw otherwise. Requires groupBy alongside it, or the request is rejected with 422.

string

Which dimension groupValue belongs to, for example SUBSCRIBER or ORG_UNIT. Required whenever groupValue is sent, and groupValue is required whenever this is sent; either one alone is rejected with 422 naming the missing one. Matched case-insensitively against the known dimensions; a value that matches none of them is rejected with 422 naming the accepted values, rather than being answered as though nothing matched.

string

Optional exact match on the request that tripped the rule, named as the transactionId field these endpoints return it under

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json
*/*