List the people and objects the matching enforcement events name

get

https://api.revenium.ai/profitstream/v2/api/ai/enforcement-events/affected

Returns the affected-object picker for the same filter the list accepts: the distinct people or objects the matching events name, each with its dimension and its event count, ordered by count descending and then by value ascending, capped at 200 rows. total is how many there are altogether, so a client can say "200 of 312" rather than implying the 200 it shows are everybody. Somebody ranked below the cap is reached with affectedSearch, which narrows these rows and total alike. That total carries the window, rule, group, request and search filters only and never level or mode, so render "N of total" only while no tier and no mode filter is active. Events carrying a value but no dimension are absent, because an exact filter needs both; they are the events written before the dimension was recorded, and they stay reachable by free-text search. Values come back in the form the list expects them, so a click is handed straight back as groupValue plus groupBy. level defaults to ALL here, so a reader who has chosen no tier sees everybody the window names rather than only the people a hard cap stopped. resolvedSince and resolvedUntil carry the window these rows were actually taken over, which is not always the one that was asked for. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

required

Revenium-generated identifier of the team to scope the list

since

string

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

until

string

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

ruleId

string

Optional Revenium-generated identifier of a cost control. When supplied, only the people and objects that rule's events name are returned.

level

string

enum

Which tier of events the returned rows are counted from. ALL is the default and counts both; HARD counts cap breaches and would-be breaches, WARN counts warning-line crossings. It narrows the rows and never total.

Allowed:

mode

string

enum

Whether the returned rows are counted from real enforcement actions, a shadow rule's would-have-done rows, or both. It narrows the rows and never total.

Allowed:

query

string

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

groupValue

string

Optional exact match on the affected person or object, which narrows this list to that one entry. Requires groupBy alongside it, or the request is rejected with 422.

groupBy

string

Which dimension groupValue belongs to. 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.

transactionId

string

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

affectedSearch

string

Optional case-insensitive substring of the affected person or object, which narrows these rows and total alike, so a reader can reach somebody who ranks below the 200-row cap. It matches the stored key: on a rule grouped by person that key is the email address, so typing part of an address finds that person. On a rule grouped by department the stored key is a raw internal identifier and this endpoint returns it hashed, so the term is matched against the department itself as well: its name as a case-insensitive substring, and the hashed identifier this endpoint hands out as a case-insensitive prefix. Typing data finds the Data Science department, the first few characters of the code on a row find that row, and the whole code still does. % and _ match themselves rather than acting as wildcards. Unlike query, which searches the whole event text, this searches the affected value alone, and it applies to this endpoint only.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/hal+json

*/*

200The matching people and objects, capped, with the distinct total

400Invalid request

401Unauthorized

403Forbidden

404Team not found

409Conflict

422Invalid since, until, ruleId, level, mode or groupBy parameter, a since and a genuinely past until spanning more than 30 days, a since after until, or groupValue sent without groupBy (or the reverse)

429Too Many Requests

500Internal server error