GET /api/v202611/wattsAlert/{alertId}

Retrieves a single Watts alert by ID, with its assignees

GetWattsAlertV202611 EncStaff + Permissions: WattsAlerts (View)
Use this endpoint to show an alert’s details or to load it into the edit dialog. The alert’s creator can read it, and so can its assignees (directly or through a user group) who have the Shared Watts Alerts View permission. The Watts chat linkage (WattsChatID and WattsChatMessageID) is returned only to the creator, because the conversation belongs to them; it is null for assignees. Returns 404 when the alert does not exist, or the caller is neither its creator nor an assignee with Shared Watts Alerts View.

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 Watts alert. integer (int32) Required

Responses

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

Response Body Parameters

WattsAlertResponseV202611
Property Description Type
assignees WattsAlertAssigneesV202611
WattsAlertAssigneesV202611 properties
Property Description Type
userGroups User groups the alert is assigned to. Group membership is evaluated when the alert runs, so users added to or removed from a group gain or lose the alert. UserGroupChild[]
UserGroupChild properties
Property Description Type
userGroupId The unique numeric identifier of the user group in the customer’s database. integer (int32)
userGroupName The group’s display name, used when selecting recipients and reviewing report distributions. string
users Users the alert is assigned to directly, including the alert’s owner when they’re assigned. Does not include members of assigned user groups. UserChild[]
UserChild properties
Property Description Type
fullName The user’s full display name. string
userCode The user’s login code, which distinguishes users whose display names are the same. string
userId The unique numeric identifier of the EnergyCAP user in the customer’s database. integer (int32)
createdBy UserChildWithActive
UserChildWithActive properties
Property Description Type
active True when the user’s account is active and can sign in. False when the user has been deactivated; deactivated users keep their records, including reports they created and shared. Required (defined) boolean
fullName The user’s full display name. Required (defined) string
hiddenUser True when the user is hidden and their name should be masked in report-author popovers. False when the user’s name can be displayed. The built-in ECI user is displayed as System User. Required (defined) boolean
userCode The user’s login code, which distinguishes users whose display names are the same. Required (defined) string
userId The unique numeric identifier of the EnergyCAP user in the customer’s database. Required (defined) integer (int32)
createdDate Date and time when the alert was created. string (date-time)
description Plain-language description of the alert’s rule, generated by Watts. Null when no description was generated. string
kql KQL rule the alert runs. Each row it returns is a trigger. string
modifiedDate Date and time when the alert was most recently modified. string (date-time)
name User-facing alert name, generated by Watts when the alert is created. string
wattsAlertId Unique numeric identifier of the Watts alert. integer (int32)
wattsChatId Unique numeric identifier of the Watts chat that produced the alert’s KQL. Load the conversation’s messages with the Watts chat message endpoint for this chat ID. Null when no chat is linked, and always null when the caller is not the alert’s owner, because the chat belongs to the owner. integer (int32)
wattsChatMessageId Unique numeric identifier of the assistant message whose KQL the alert saved. Null when no chat is linked, and always null when the caller is not the alert’s owner, because the chat belongs to the owner. integer (int32)
Example Response application/json
{  "assignees": {    "userGroups": [
      {      "userGroupId": 1,      "userGroupName": "string"
    }
    ],    "users": [
      {      "fullName": "string",      "userCode": "string",      "userId": 1
    }
    ]
  },  "createdBy": {    "active": false,    "fullName": "string",    "hiddenUser": false,    "userCode": "string",    "userId": 1
  },  "createdDate": "2026-11-20",  "description": "string",  "kql": "string",  "modifiedDate": "2026-11-20",  "name": "string",  "wattsAlertId": 1,  "wattsChatId": 1,  "wattsChatMessageId": 1
}
403 Forbidden You do not have permission to access this resource. Check your user role and permissions.
404 Not Found The requested resource was not found. Verify the ID or path is correct.