Developers API
getAlertMatrix
Fetches an Alert Group.
The matrix is provided in JSON serialized format. It contains a series of contact-channels, each containing an array of alert levels:
{"<ContactChannelID>": [AlertLevel 1, AlertLevel 2], "<ContactChannelID>": [AlertLevel 5], ...}
This JSON string can be used with the setAlertMatrix API command.
Request Parameters
| Parameter | Data Type | Description | Required | Default |
|---|---|---|---|---|
| groupid | integer | The id of the group you want to get | Optional | |
| mode | enum | Deprecated. GROUP should always be used. | Optional | GROUP |
| hostid | integer | Deprecated. Use groupid instead. | Optional |
Response Data
| Response Variable | Data Type | Description |
|---|---|---|
| errorcode | integer | Returns an errorcode of 0 if call is successful. |
| matrix | string | A JSON-string representation of the matrix. |