Alert

Query alerts

Returns a paginated list of alerts filtered by observer, observation type, asset, metric value, and date range.

get/v1/alerts

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/alerts
  • Auth: HTTP bearer

Query parameters

alertIdstring

Filter by alert ID

observerIdstring

Filter by observer ID

evaluationType'NUMERIC' | 'TEMPORAL' | 'STRUCTURAL'

Filter by evaluation type

observationKindstring

Filter by observation kind

tagsstring[]

Filter by observation tags

assetIdstring

Filter by asset ID

metricValueIdstring

Filter by metric value ID

fromDatestring

Filter to alerts at or after this timestamp (ISO-8601)

toDatestring

Filter to alerts at or before this timestamp (ISO-8601)

includeHistoryboolean

Whether to include the alert's history events in the response (only applies when alertId is provided)

pageinteger

Page number (1-based)

sizeinteger

Number of items per page

ascendingboolean

Sort direction — true for ascending

sortBystring

Field to sort by

Response

Paginated list of alerts returned successfully

currentPageinteger

Current page number

pageSizeinteger

Number of items per page

totalItemsinteger

Total number of items across all pages

totalPagesinteger

Total number of pages available based on page size and total items

Example response

{
  "currentPage": 1,
  "pageSize": 20,
  "totalItems": 1,
  "totalPages": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.