GetLMAlertHistory

This web method retrieves the alert history for all MBG monitors of a specific type within a specified time range.

Request parameters

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

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

In the URL above, specify the following parameters:

  • username—The DPN account username
  • password—The DPN account password
  • monitorType—Specifies the class of MBG monitor data to retrieve. Specify one of the following values:
Value Description
ALL To return information for all monitor types (‘PRIVATEPEER’, ‘MOBILE’)
PRIVATEPEER To return information for PRIVATEPEER tests only
MOBILE To return information for MOBILE tests only
  • startTime—Start time for the request window in format* YYYY-MM-DD hh:mm:ss*
  • endTime—End time for the request window in format* YYYY-MM-DD hh:mm:ss*

Note

If the request time frame (from startTime to endTime) is older than 33 days, data may not be returned, because data older than 33 days may not exist.

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 MBG monitor class.

  • startTime has a valid date/time format.

  • endTime has a valid date/time format.

  • The size of the request time frame (difference between startTime and endTime) must be less than or equal to 24 hours.

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:

<?xml version="1.0" encoding="utf-8"?>
<lastmileAlertHistoryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                              xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                              xmlns="http://gomeznetworks.com/webservices/">
  <status>FAILED</status>
  <errorMessage>Invalid Account Specified</errorMessage>
</lastmileAlertHistoryResponse>

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

<?xml version="1.0" encoding="utf-8"?>
<lastmileAlertHistoryResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                              xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                              xmlns="http://gomeznetworks.com/webservices/">
  <status>SUCCESS</status>
  <alertSummary messageId="32757" monitorId="15642" alertId="102" alertType="Response Time Failure"
                alertState="SEVERE" progression="REMINDER">
    <messagePayload>
      <GPN_MESSAGE xmlns="">
        <msgType>GPN_ALERT_MESSAGE</msgType>
        <reportHost>www.gomeznetworks.com</reportHost>
        <alert>
          <alertId>102</alertId>
          <time>9/1/2014 12:05:54 AM</time>
          <GMTtime>9/1/2014 12:05:54 AM</GMTtime>
          <status>SEVERE</status>
          <isPercent>0</isPercent>
          <persistentInterval>15</persistentInterval>
          <progressionState>REMINDER</progressionState>
        </alert>
        <responseTime>
          <baselineRange>24</baselineRange>
          <localRange>60</localRange>
          <respAlertType>Static</respAlertType>
          <WarningThreshold>200</WarningThreshold>
          <SevereThreshold>1000</SevereThreshold>
          <CurrAvgRespTimeInMS>9361</CurrAvgRespTimeInMS>
          <WarningCount>0</WarningCount>
          <SevereCount>2</SevereCount>
          <GoodCount>2</GoodCount>
          <TotalCount>2</TotalCount>
        </responseTime>
        <account>
          <acctId>10</acctId>
          <acctName>QA - Test Power End User1</acctName>
        </account>
        <monitor type="PrivatePeerPayload">
          <monid>15642</monid>
          <mondesc>Private Peer Last Mile Test with Alert - ericg - FF Agent</mondesc>
          <class>PP_MONITOR</class>
          <freq>60</freq>
          <comflg>1</comflg>
        </monitor>
      </GPN_MESSAGE>
    </messagePayload>
  </alertSummary>
  <alertSummary messageId="32757" monitorId="15642" alertId="102" alertType="Response Time Failure"
                alertState="SEVERE" progression="REMINDER">
    <messagePayload>
      <GPN_MESSAGE xmlns="">
        <msgType>GPN_ALERT_MESSAGE</msgType>
        <reportHost>www.gomeznetworks.com</reportHost>
        <alert>
          <alertId>102</alertId>
          <time>9/1/2014 12:45:56 AM</time>
          <GMTtime>9/1/2014 12:45:56 AM</GMTtime>
          <status>SEVERE</status>
          <isPercent>0</isPercent>
          <persistentInterval>15</persistentInterval>
          <progressionState>REMINDER</progressionState>
        </alert>
        <responseTime>
          <baselineRange>24</baselineRange>
          <localRange>60</localRange>
          <respAlertType>Static</respAlertType>
          <WarningThreshold>200</WarningThreshold>
          <SevereThreshold>1000</SevereThreshold>
          <CurrAvgRespTimeInMS>9101</CurrAvgRespTimeInMS>
          <WarningCount>0</WarningCount>
          <SevereCount>2</SevereCount>
          <GoodCount>2</GoodCount>
          <TotalCount>2</TotalCount>
        </responseTime>
        <account>
          <acctId>10</acctId>
          <acctName>QA - Test Power End User1</acctName>
        </account>
        <monitor type="PrivatePeerPayload">
          <monid>15642</monid>
          <mondesc>Private Peer Last Mile Test with Alert - ericg - FF Agent</mondesc>
          <class>PP_MONITOR</class>
          <freq>60</freq>
          <comflg>1</comflg>
        </monitor>
      </GPN_MESSAGE>
    </messagePayload>
  </alertSummary>
</lastmileAlertHistoryResponse>

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
<alertHistoryResponse> Top-level container of the XML response of this web service none <status> <errorMessage> <alertSummary>
<status>
SUCCESS FAILED
<lastmileAlertHistoryResponse> none
<errorMessage> Detailed error message if status=”FAILED” <lastmileAlertHistoryResponse> none
<alertSummary> Container for alert summary information and alert payload <lastmileAlertHistoryResponse> <messagePayload>
messageId DPN message ID    
monitorId MBG monitor ID    
alertId The following integral values are possible for the different alert types:
  • 101—Transaction Failure
  • 102—Response Time Failure
   
alertType The following values correspond to alertId values:
  • Transaction Failure (alertId=101)
  • Response Time Failure (alertId=102)
   
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 user-specified non-response-time criteria.
  • Warning—Indicates a violation of user-specified response time criteria.
  • Severe—Indicates a violation of user-specified response time criteria.
   
progression The following values for progression are possible:
  • Initial—First alert sent in alertState.
  • Reminder—Alert sent repeatedly.
  • Condition Improved—alertState has changed from an alertable to a non-alertable state.
   
<messagePayload> Container for actual alert payload <alertSummary>