API Reference
Log In
API Reference

List recent enforcement events for a team

Returns the enforcement events for the team, in pages. Includes both shadow-mode evaluations (would have blocked) and real enforcement actions. Events are listed by the time Revenium recorded them, newest first. By default only events where the limit was reached are returned. Pass level=WARN for warning-line crossings, or level=ALL for both. Each event carries structured fields (ruleName, action, metricType, currentValue, threshold, usagePercent, tenantId, level, groupValue, groupBy, transactionId). rawDetails holds the full event text for any field that could not be read. The list is answered over a date range. Both since and until are optional and both ends are inclusive. The range ends now whenever until is omitted or is itself at or after now; an until genuinely in the past is used as given. With no since supplied the range starts 30 days before that end. A since more than 30 days before the end is moved forward to the newest 30 days whenever the end resolved to now, so an ordinary last-30-days request is not refused by clock or network drift. Paired with an until genuinely in the past, the same over-long range is rejected with 422 naming the maximum, rather than silently narrowed. The range is measured on the time Revenium recorded the event, which is also the time the list is sorted by.

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

Optional free-text search. Matched case-insensitively against the event text, which includes the rule name, the group (a person's email on a per-person rule) and the masked API key hint.

string
required

ID of the team that owns this data.

string

Optional ISO-8601 timestamp starting the date range, inclusive, and measured on the time Revenium recorded the event. Omit it and the range starts 30 days before the end of the range. A since more than 30 days before the end is moved forward to the newest 30 days whenever the range's end resolves to now, which happens when until is omitted or is itself at or after now. Paired with an until genuinely in the past, the same over-long range is rejected with 422 instead of moved forward. A since after until is also rejected with 422, rather than answered with an empty page.

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 10

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
string

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

date-time

Optional ISO-8601 timestamp ending the date range, inclusive, and measured on the time Revenium recorded the event. Mirrors since, which starts the range. Omit it and the range ends now. An until at or after now is also treated as now, exactly like omitting it, which is what keeps an ordinary last-30-days request from being refused by clock or network drift. An until genuinely in the past is used as given, and paired with a since more than 30 days before it, the range is rejected with 422 naming the maximum.

string
enum

Whether to return real enforcement actions, a shadow rule's would-have-done rows, or both. ENFORCED returns only events where something was actually blocked or warned on, SHADOW only the would-have rows a rule in shadow mode produced, and ALL (the default) both. It composes with level rather than replacing it, and level defaults to HARD, so mode=SHADOW on its own returns shadow cap breaches only. Send level=ALL alongside it to get shadow warning-line crossings too.

Allowed:
string
enum

Which tier of events to return. HARD (the default) returns cap breaches and would-be breaches, which is what a rule's block counts are built from. WARN returns warning-line crossings, where nothing was blocked. ALL returns both.

Allowed:
string

Optional exact match on the affected person or object. Send back the value this endpoint returned in groupValue. Requires groupBy alongside it, or the request is rejected with 422.

string

Which dimension groupValue belongs to: SUBSCRIBER, DEPARTMENT, MODEL and so on. Must be sent together with groupValue, never alone: sending either one without the other is rejected with 422 naming whichever is missing. 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 with an empty page.

string

Optional exact match on the transaction ID of the request that tripped the rule.

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
*/*