GET /api/v202608/esaalert/enabledcounts

Counts the enabled threshold alerts on each of several meters, across all of each meter's channels

GetEnabledAlertCountsV202608 Permissions: Meters (View)
Use this to show an alert count next to a list of meters without listing every alert. A meter’s count is exactly the total number of rows ListThresholdAlerts (GET api/v202608/esaalert) returns for that meterId with alertStatus ’enabled’ and the default alert types: one per enabled (alert, channel) association on any of the meter’s channels, Above/Below and Total Over Time only (Trend Insights are not counted). Like the list, it only counts meters beneath the calling user’s topmost place, so a meter outside it reports 0. At most 500 distinct meter ids per request.

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Query Parameters

Name Description Type Required
meterId Ids of the meters to count, repeated in the query string (meterId=1&meterId=2). Duplicates are ignored. At most 500. array Optional

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

EsaAlertMeterCount
Property Description Type
enabledAlertCount Enabled Above/Below Threshold and Total Over Time alerts on any of the meter’s channels. Equal to the total number of rows the alert list returns for this meterId with alertStatus ’enabled'. integer (int32)
meterId The meter the count is for. integer (int32)
Example Response application/json 
[
  {    "enabledAlertCount": 1,    "meterId": 1
  }
]
400 Bad Request The request was malformed or contains invalid parameters. Check the request body and query parameters.
403 Forbidden You do not have permission to access this resource. Check your user role and permissions.