API Reference
Getting startedVisit een.comMy Application/Login

/alerts

get
https://{BaseUrl}/api/v3.0/alerts

Search and sort alerts by creatorId, alertType, actorId, actorType, actorAccountId, ruleId, eventId, locationId, and priority. Optional information can be requested with include.

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

Language query overrides Accept-Language header

string

Filter by creatorId

date-time

Filter by timestamp__lte

date-time

Filter by timestamp__gte

alertType__in
array of strings

Filter by alertType (supports multiple values)

alertType__in
actorId__in
array of strings

Filter by actorId (supports multiple values)

actorId__in
actorType__in
array of strings

Filter by actorType (supports multiple values)

actorType__in
string

Filter by actorAccountId

uuid

Filter by ruleId

ruleId__in
array of uuids

Filter by one or more rule IDs (supports multiple values)

ruleId__in
string

Filter by eventId

locationId__in
array of strings

Filter by one or more location IDs.

locationId__in
integer
0 to 10

Filter by priority__gte

integer
0 to 10

Filter by priority__lte

boolean

If set to true, the API will include alerts that are invalidated by Human reviewer.

alertActionId__in
array of uuids

Filter by one or more alert action IDs (supports multiple values)

alertActionId__in
alertActionStatus__in
array of strings

Filter by one or more alert action statuses (supports multiple values)

alertActionStatus__in
include
array of strings

Specify additional data to include in the response (supports multiple values like data and actions).

include
sort
array of strings
Defaults to -timestamp

Sort by timestamp

sort
string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

integer
1 to 500
Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Headers
string

Source data set is api/v3.0/languages

Responses

Updated 5 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago