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

Query Params

language

string

Language query overrides Accept-Language header

creatorId

string

Filter by creatorId

timestamp__lte

date-time

Filter by timestamp__lte

timestamp__gte

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

string

Filter by actorType

actorAccountId

string

Filter by actorAccountId

ruleId

string

Filter by ruleId

eventId

string

Filter by eventId

locationId__in

array of strings

Filter by one or more location IDs.

locationId__in

priority__gte

integer

0 to 10

Filter by priority__gte

priority__lte

integer

0 to 10

Filter by priority__lte

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

pageToken

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.

pageSize

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

Accept-Language

string

Source data set is api/v3.0/languages

Responses

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.cxxx.eagleeyenetworks.com/api/v3.0/alerts?sort=-timestamp&pageSize=100' \
3
     --header 'accept: application/json'

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

application/json

200Alert results

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

500Something went wrong in the server. Please try again.