GetAccountMonitors2

This web service method retrieves the complete set of the Dynatrace Portal and MBG monitors configured for your account by test type and status.

Request parameters

You can use either a SOAP or HTTP call for this method. To call this web service from the browser, submit the following Get Request:

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx/GetAccountMonitors2?sUsername=string&sPassword=string&sMonitorSetDesignator=string&sstatusdesignator=string

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • sMonitorSetDesignator - The valid monitor types are:
    • ALL
    • BROWSER
    • BROWSERBENCHMARK
    • BROWSERANDBENCHMARK
    • LM
    • LMMOBILE
    • LMMONITOR
    • LMTRANSACTION
    • MOBILE
    • PP
    • PPMOBILE
    • PPMONITOR
    • PPTRANSACTION
    • STREAM
    • TRANSACTION
    • TRANSACTIONBENCHMARK
    • TRANSACTIONANDBENCHMARK
    • UTATX
    • UTATXANDBENCHMARK
    • UTATXBENCHMARK
  • sStatusDesignator - Specify one of the following:
    • ALL
    • ACTIVE
    • INACTIVE

Validation criteria

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

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.
  • sMonitorSetDesignator is valid.
  • sStatusDesignator is valid.

For more information, see Retrieving Specific Account Management Data.

Response XML

This web service returns the following information according to its operation status:

STATUS_FAILED

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAccountMonitors2Response
    xmlns="http://gomeznetworks.com/webservices/">
    <GetAccountMonitors2Result>
     <Status>
       <eStatus>STATUS_FAILED</eStatus>
       <sErrorMessage>ERROR  : INVALID MONITOR SET DESIGNATOR
       SPECIFIED MUST BE (ALL | STREAM | LM | LMMONITOR
       | LMTRANSACTION | PP | PPMONITOR | PPTRANSACTION
       | MOBILE | LMMOBILE | BROWSER | PPMOBILE | BROWSERBENCHMARK
       | BROWSERANDBENCHMARK | UTATX | UTATXBENCHMARK
       | UTATXANDBENCHMARK | TRANSACTION | TRANSACTIONBENCHMARK
       | TRANSACTIONANDBENCHMARK)
       </sErrorMessage>
      </Status>
     </GetAccountMonitors2Result>
    </GetAccountMonitors2Response>
 </soap:Body>
</soap:Envelope>

SUCCESS

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

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetAccountMonitors2Response
     xmlns="http://gomeznetworks.com/webservices/">
      <GetAccountMonitors2Result>
        <Status>
          <eStatus>STATUS_SUCCESS or STATUS_FAILED or STATUS_DATA_NOT_READY</eStatus>
          <sErrorMessage>string</sErrorMessage>
        </Status>
        <MonitorSet>
          <Monitor mid="481866" desc="4 step vanguard.mobile
            iPhone - 28-Aug-2013 20:38:18 - 2 - Mobile Agent"
            url="" class="PP_TRANSACTION" status="ACTIVE" account="10"
            timeoutinsec="300" frequencyinms="3600" docomponents="0"
            created="8/28/2013 8:38:19 PM"
            modified="8/28/2013 8:38:19 PM"
            isBrowser="true" isMobile="true">
        </Monitor>
        </MonitorSet>
        <MbgMonitorSet>
         <MbgMonitor>
          <id>15578</id>
          <groupId>13950</groupId>
          <mid>499273</mid>
          <status>ACTIVE</status>
        </MbgMonitor>
      </MbgMonitorSet>
     </GetAccountMonitors2Result>
   </GetAccountMonitors2Response>
 </soap:Body>
</soap:Envelope>

Output

The following table summarizes the main elements, attributes, and possible attribute values in the XML response returned by this web service. See the for the complete definition of this XML response. For more information, see Retrieving Account Management Data.

Attribute Description Parent Element Child Elements
<GetAccountMonitors2Result> Top-level container for the XML response of this web service None <Status> <MonitorSet> <MbgMonitorSet>
<Status> The container for the information about the status of the operation <GetAccountMonitors2Result> <eStatus> <sErrorMessage>
<eStatus> STATUS_SUCCESS STATUS_FAILED STATUS_DATA_NOT_READY <Status> None
<sErrorMessage> A detailed error message if the status is STATUS_FAILED <Status> None
<MonitorSet> The container for the set of tests configured for the account <GetAccountMonitors2Result> <Monitor>
<Monitor> The container for the information for an individual test <MonitorSet> None
mid The unique identifier for the test
desc The description of the test
url The URL that is being tested
class The type of test:
  • MONITOR
  • TRANSACTION
status The status of the test:
  • ACTIVE
  • INACTIVE
account The ID of the account that created the test
timeoutinsec The length of time, in seconds, before a test times out on retry
frequencyinms The interval, in milliseconds, between the test runs
docomponents
  1. If components are downloaded
  2. Otherwise
created The date the test was created
modified The last time the test was modified
<MbgMonitorSet> The container for the MBG monitors configured for the account <GetAccountMonitors2Result> <MbgMonitor>
<MbgMonitor> <MbgMonitorSet> None
id The ID of the MBG monitor
groupId The ID of the monitor batch group
mid The ID of the monitor
status The status of the monitor:
  • ACTIVE
  • INACTIVE

Other SOAP and HTTP examples

http://gpn.webservice.gomez.com/AccountManagementWS_20/AccountManagementWS.asmx?op=GetAccountMonitors2