GET /api/v202608/esaalert/{alertId}/channels

Lists channels eligible to be added to an existing threshold alert

GetEligibleChannelsForAlertV202608 Permissions: Meters (View)
Use this endpoint to populate a channel picker when adding channels to an existing alert (see POST /esaalert/{esaAlertId}/channel). Eligible channels must be a primary value or primary demand channel, must not already be associated with the alert, must have a summarization method compatible with the alert type and direction (Max or Average for ‘above’; Max, Average, or Min for ‘below’; Sum for ’total over time’), and must have the same unit as the alert’s threshold configuration. The summarization method and direction together decide whether the alert means the threshold was ever crossed or crossed for the entire interval - for example, a Max channel with ‘above’ fires as soon as any reading exceeds the threshold, while an Average channel with ‘above’ only fires once the interval’s average does. For demand-peak alerts, prefer a channel whose interval matches the utility’s demand window; a shorter-interval Max channel peaks higher than the billed demand and can fire on peaks that are never actually billed. Results are grouped by meter.

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.

Path Parameters

Name Description Type Required
alertId Unique numeric identifier of the alert to find eligible channels for, supplied via the request path integer (int32) Required

Query Parameters

Name Description Type Required
placeId Optional place ID; when supplied, only channels on meters at or beneath this place are included integer (int32) Optional
meterName Optional text to match against meter names, case-insensitive, matching anywhere in the name string Optional

Responses

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

Response Body Parameters

Array of:

EsaAlertEligibleChannelsMeter
Property Description Type
esaChannels Channels on this meter eligible to be added to the alert. EsaAlertEligibleChannel[]
EsaAlertEligibleChannel properties
Property Description Type
channelType Whether this channel is the meter’s primary value or primary demand channel. integer (int32)
esaChannelId Primary key of the EsaChannel record. integer (int32)
meterId Primary key of the LogicalDevice (meter) record. integer (int32)
meterName Display name of the meter. string
Example Response application/json
[
  {    "esaChannels": [
      {      "channelType": 1,      "esaChannelId": 1
    }
    ],    "meterId": 1,    "meterName": "string"
  }
]
400 Bad Request The request was malformed or contains invalid parameters. Check the request body and query parameters.
404 Not Found The requested resource was not found. Verify the ID or path is correct.