Alert

List the alerts

Changed on

List a page of alerts by filter.

get/alerts

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/alerts
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, min = 1

limitinteger

Page Size, min = 1, max = 100

startTimeinteger required

The start time for querying alerts in milliseconds

endTimeinteger required

The end time for querying alerts in milliseconds

severityIdsinteger[]

The alert severity identifiers to filter. The currently supported severity IDs are 1 for critical, 2 for warning, and 3 for info.

categoryIdsinteger[]

The alert category ID to filter

messageMetadataIdsinteger[]

The message metadata ID list to filter

acknowledgedboolean

The acknowledged to filter, return global data if not specified

siteIdinteger

The site id to filter

floorIdinteger

The floor id to filter

buildingIdinteger

The building id to filter

keywordstring

The keyword to filter, such as summary, severity, source, etc.

sortField'TIMESTAMP' | 'SOURCE'

All available device sort fields<br/><br/>TIMESTAMP = Last Detected<br/> SOURCE = Source Name

The sort field

order'ASC' | 'DESC'

The sort order (descending by default)

Response

OK

pageinteger required

The current page number

countinteger required

The element count of the current page

total_pagesinteger required

The total page number based on request page size

total_countinteger required

The total element count

Changes

  • 242a0e1b1b40Revision changes
    • breaking

      for the query request parameter sortField, default value TIMESTAMP was added

    • breaking

      for the query request parameter order, default value was changed from ASC to DESC