GetAlertStates

This web method retrieves the complete set of alert states for all Backbone nodes for all monitors of a specific type.

Request parameters

To call this web service from your browser, submit the following HTTP Get Request:

https://gpn.webservice.gomez.com/AlertManagementService20/AlertManagementWS.asmx/GetAlertStates?username=string&password=string&monitorType=string

In the URL above, specify the following parameters, listed and described below:

  • username—The account username
  • password—The account password
  • monitorType—Specifies the class of Backbone monitor data to retrieve. Specify one of the following values:
Value Description
BROWSERTX To return information for BROWSERTX tests only
ALL To return information for all monitor types (‘MONITOR’, ‘PP_MONITOR’, ‘LM_MONITOR’, ‘LM_TRANSACTION’, ‘PP_TRANSACTION’, ‘BROWSER TRANSACTION’)

Validation criteria

This web service uses the following criteria to validate the incoming request:

  • username is valid for an active account.

  • password is valid for the specified username.

  • monitorType specifies a valid monitor class.

Response XML

This web service method returns information according to its operation status.

If the web service operation fails, the FAILED status and an error message are returned in the following XML format:

<alertHistoryResponse xmlns="http://gomeznetworks.com/webservices/"
                      xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <status>FAILED</status>
        <errorMessage>No Monitors Exist For The Specified Account </errorMessage>
</alertHistoryResponse>

If the web service operation succeeds, the information requested is returned in the following XML format:

<backboneAlertStateResponse>
   <status>SUCCESS</status>
     <monitor freqInSec="3600" status="ACTIVE" class="TRANSACTION"
       timeoutInSec="300" doComponents="true" doSummary="false"
       desc="TestLevel_Type5_Static_MultipleIE" id="210481">
       <site status="ACTIVE" id="885"
          backbone="TPNTS9 - Boston, MA - Savvis"
          publicIP="206.31.247.250" hostName="TPNTS9VN01"
          countryCode="US" state="MA" city="Boston"
          name="TPNTS9 - Boston, MA - Savvis">
         <alertState baselineResponseTimeInMS="1519"
           responseTimeInMS="1592" timeStampGMT="2012-06-20
           12:53:07.537"  alertState="SEVERE"
           alertType="Response Time Failure" alertId="5"/>
        </site>
     </monitor>
     <monitor freqInSec="3600" status="ACTIVE" class="TRANSACTION"
       timeoutInSec="300" doComponents="true"
       doSummary="false"
       desc="PageLevel_Type5_Static_SingleIE" id="212867">
       <page pageSeqNum="0" url="http://www.google.com/">
        <site status="ACTIVE" id="777"
          backbone="TPNTS7 - MA: Boston" publicIP="172.16.48.138"
          hostName="TPNTS7VN01" countryCode="US" state="MA"
          city="Lexington" name="TPNTS7 - MA: Boston">
         <alertState responseTimeInMS="459"
           timeStampGMT="2012-06-14 23:32:38.307" alertState="WARNING"
           alertType="Page Response Time" alertId="2005"
           responseTimeThresholdInMS="1"/>
        </site>
         <site status="ACTIVE" id="884" backbone="TPNTS10 - Boston,
           MA - Savvis" publicIP="206.31.247.249" hostName="TPNTS1VNA0"
           countryCode="US"  state="MA" city="Boston" name="TPNTS10 - Boston,
           MA - Savvis">
          <alertState responseTimeInMS="676"
            timeStampGMT="2012-04-23 18:19:12.187"
            alertState="WARNING" alertType="Page Response Time"
            alertId="2005" responseTimeThresholdInMS="1"/>
        </site>
        <site status="ACTIVE" id="885" backbone="TPNTS9 - Boston, MA
          - Savvis" publicIP="206.31.247.250" hostName="TPNTS9VN01"
          countryCode="US" state="MA" city="Boston" name="TPNTS9
          - Boston, MA - Savvis">
          <alertState responseTimeInMS="520"
            timeStampGMT="2012-06-20 10:52:24.727" alertState="WARNING"
            alertType="Page Response Time" alertId="2005"
            responseTimeThresholdInMS="1"/>
         </site>
      </page>
      <page pageSeqNum="1" url="http://www.google.com/XXX">
         .
         .
         .
      </page>
   </monitor>
</backboneAlertStateResponse>

Output

The following table summarizes the main elements, attributes, and possible attribute values in the XML response returned by this web service. See the Alert Management WSDL for the complete definition of this XML response.

XML Elements & Attributes Description Parent Element Child Elements
<backboneAlertStateResponse> Top-level container of the XML response of this web service none <status> <errorMessage> <monitor>
<status>
SUCCESS FAILED
<backboneAlertStateResponse> none
<errorMessage> Detailed error message if status=”FAILED” <backboneAlertStateResponse> none
<monitor> Container for monitor summary information and the set of the pages and sites where the monitor is in an alert state. <backboneAlertStateResponse> <site>/<page>
id Dynatrace Portal monitor ID    
desc Dynatrace Portal monitor description    
doSummary True, if monitor is running in summary mode; false, otherwise    
doComponents True, if monitor is collecting performance information for page components; false, otherwise    
timeoutInSec The number of seconds before the monitor times out    
class The type of test: BROWSERTX    
status
ACTIVE INACTIVE DELETE
   
freqInSec The number of seconds between test runs    
<page> Container for the Page summary information and the sites where the page is in an alert state <monitor> <site>
pageSeqNum Step ID for the monitor    
url URL for the step    
<site> Container for the site summary information and the alert payload <monitor> <alertState>
id Dynatrace Portal site identifier    
name Name of the site    
status
ACTIVE INACTIVE
   
city City where the site is located    
state State where the site is located    
countryCode Country code of the site    
hostName Name of the host server    
publicIP IP address of the site    
backbone ISP of the site    
<alertState> Container for alert summary information <site>  
alertId The following integral values are possible for the different alert types:
  • 1—Page Host (BROWSERTX)
  • 2—Page Inaccessible (BROWSERTX)
  • 3—Page Object (BROWSERTX)
  • 4—Transaction Failure (BROWSERTX)
  • 5—Response Time (BROWSERTX)
  • 6—Content Match (BROWSERTX)
  • 7—Byte Limit (BROWSERTX)
  • 2004—Page Transaction Failure (BROWSERTX)
  • 2005—Page Response Time (BROWSERTX)
   
alertType The following values correspond to alertId values:
  • Page Host Failure (alertId=1)
  • Page Inaccessible Failure (alertId=2)
  • Page Object Failure (alertId=3)
  • Transaction Failure (alertId=4)
  • Response Time Failure (alertId=5)
  • Content Match Failure (alertId=6)
  • Byte Limit Failure (alertId=7)
  • Page Transaction Failure (alertId=2004)
  • Page Response Time Failure (alertId=2005)
   
alertState The following values for the current state of the alert are possible:
  • Good—No user-specified criteria has been violated.
  • Bad—Indicates a violation of non-response-time criteria.
  • Warning—Indicates a violation of user-specified response time criteria.
  • Severe—Indicates a violation of user-specified response time criteria.
   
timeStampGMT The timestamp in GMT when the test last violated user-specified criteria and generated an alert    
thresholdVal   Depending on alert type, value is the same as other attributes as follows:
  • AlertId = 3: See pageObjectThreshold.
  • AlertId = 5: See baselineResponseTimeInMS.
  • AlertId = 7: See byteLimit.
  • AlertId = 2004: See Page Transaction Failure.
  • AlertId = 2005: See Page Response Time.
   
triggerVal Depending on alert type, value is the same as other attributes as follows:
  • AlertId = 1: See returnCode.
  • AlertId = 5: See responseTimeInMS.
  • AlertId = 7: See bytesDownloaded.
  • AlertId = 2004: See Page Transaction Failure.
  • AlertId = 2005: See Page Response Time.
   
byteLimit User-defined byte-limit threshold
Appears only for alertId=7.
   
bytesDownloaded Actual number of bytes downloaded
Violation of the specific byteLimit
Appears only for alertId=7.
   
contentMatch User-defined content match criteria
Appears only for alertId=6.
   
responseTimeInMS Actual response time in milliseconds
  • alertId=5
  • AlertId = 2004
  • AlertId = 2005
   
baselineResponseTimeInMS Response time threshold in milliseconds for dynamic response time alerts
  • alertId=5
  • AlertId = 2004
  • AlertId = 2005
   
responseTimeThresholdInMS User-defined response time threshold in milliseconds for non-dynamic response time alerts (alertId=5)
  • AlertId = 2004
  • AlertId = 2005
   
pageSeqNo Number of page that causes the transaction failure (alertId=4)
  • AlertId = 2004
  • AlertId = 2005
   
pageObjectThreshold User-defined threshold for number of objects failing download
Appears only for alertId=3.
   
pageObjects Actual number of page objects downloaded that caused the pageObjectThreshold violation
Appears only for alertId=3.
   
returnCode
  • Network error code for alertId=1
  • HTTP error code for alertId=2
  • Error code for alertId=4
   
IP IP address of failing server
Appears only for alertId=1,2.