GET api/Alert?APIKey={APIKey}&Limit={Limit}&Offset={Offset}&AlertStatus={AlertStatus}&DateFrom={DateFrom}&DateTo={DateTo}&Order={Order}&AlertID={AlertID}

List Alerts

Request Information

URI Parameters

NameDescriptionTypeAdditional information
APIKey

string

Required

Limit

Page size. Default is 10. Max value for this parameter is 100.

integer

Default value is 10

Offset

Starting point for the result set

integer

Default value is 0

AlertStatus

Open = 1, Closed = 2, Assigned = 5, All = 0

integer

Default value is 0

DateFrom

string

None.

DateTo

string

None.

Order

"desc" or "asc"

string

Default value is desc

AlertID

integer

None.

Body Parameters

None.

Response Information

Resource Description

AlertsResponse
NameDescriptionTypeAdditional information
alerts

Collection of Alert

None.

limit

integer

None.

offset

integer

None.

total

integer

None.

Response Formats

text/json, application/json

Sample:
{
  "alerts": [
    {
      "AlertID": 1,
      "CreatedDate": "01/27/17 08:18:29",
      "Sender": "some user",
      "Topic": "New Incident 1 on Server",
      "MessageText": "Background response time > 250 milliseconds for at least 5 minutes on Server",
      "AlertStatus": "Closed",
      "Owner": "No Owner",
      "OwnerID": 0,
      "Priority": "No Priority",
      "Source": "NewRelic",
      "SourceName": "NewRelic",
      "SourceID": "2918317",
      "ResolutionDate": "01/27/17 08:31:28",
      "WithinSLA": "Yes",
      "TargetSLADate": "01/30/17 08:18:29",
      "Resolution": "",
      "AlertURL": null,
      "Deliveries": [
        {
          "ContactName": "Agent, Johnson",
          "FirstAttemptDateTime": "01/27/17 08:18:29",
          "LastAttemptDateTime": "01/27/17 08:18:40",
          "FirstAcknowledgeDateTime": "",
          "ContactMethodCount": 2
        }
      ],
      "Recipients": [
        {
          "RecipientTypeID": 2,
          "RecipientID": 33,
          "RecipientName": "Agent, Johnson",
          "RecipientType": "User"
        }
      ]
    },
    {
      "AlertID": 2,
      "CreatedDate": "01/26/17 20:06:44",
      "Sender": "some user",
      "Topic": "website-1 is Down",
      "MessageText": "website-1 is Down",
      "AlertStatus": "Closed",
      "Owner": "No Owner",
      "OwnerID": 0,
      "Priority": "Critical",
      "Source": "Datadog",
      "SourceName": "Datadog",
      "SourceID": "610852",
      "ResolutionDate": "01/27/17 08:08:18",
      "WithinSLA": "No",
      "TargetSLADate": "01/27/17 00:06:44",
      "Resolution": "",
      "AlertURL": null,
      "Deliveries": [
        {
          "ContactName": "s, shashu",
          "FirstAttemptDateTime": "01/26/17 20:06:441",
          "LastAttemptDateTime": "01/26/17 20:08:44",
          "FirstAcknowledgeDateTime": "",
          "ContactMethodCount": 2
        }
      ],
      "Recipients": [
        {
          "RecipientTypeID": 2,
          "RecipientID": 3345,
          "RecipientName": "s, shashu",
          "RecipientType": "User"
        }
      ]
    }
  ],
  "limit": 10,
  "offset": 0,
  "total": 100
}