List the people and objects the matching enforcement events name

get

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

Returns the distinct people or objects named by the events matching the same filters as the events list, each with its dimension and its event count, ordered by count descending and then by value ascending, capped at 200 entries. total is how many there are altogether, so you can tell "200 of 312" from "200 of 200". Somebody ranked below the cap is reached with affectedSearch, which narrows these entries and total alike. That total applies the window, rule, group, request and search filters only and never level or mode, so compare it with the number of entries only while no tier and no mode filter is applied. Events carrying a value but no dimension are absent, because an exact filter needs both; they are older events written before the dimension was recorded, and they stay reachable by free-text search. Values come back in the form the list expects, so you can send one straight back as groupValue plus groupBy. level defaults to ALL here, so with no tier chosen you see everybody the window names rather than only the people a hard cap stopped. resolvedSince and resolvedUntil carry the window these entries were actually taken over, which is not always the one that was asked for. The response is a single object, not a paged list.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

teamId

string

required

ID of the team that owns this data.

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 text, 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 transaction ID of the request that tripped the rule

affectedSearch

string

Optional case-insensitive substring of the affected person or object. It narrows these entries and total alike, so you can reach somebody who ranks below the 200-entry cap. On a rule grouped by person it matches the email address, so typing part of an address finds that person. On a rule split by department, search by the department ID this endpoint returns or by the department's name: the name is matched as a case-insensitive substring, and the ID as a case-insensitive prefix. Typing data finds the Data Science department, the first few characters of the ID on an entry find that entry, and the whole ID does too. % 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

504Gateway Timeout