GetAccountMonitors

Use this method to retrieve a set of monitors configured for the 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/GetAccountMonitors?sUsername=string&sPassword=string&sMonitorSetDesignator=string&sStatusDesignator=string

After specifying the following parameters:

  • sUsername – The account username
  • sPassword – The account password
  • sMonitorSetDesignator - Specify the type of tests to retrieve:
    • ALL
    • BROWSER
    • BROWSERBENCHMARK
    • BROWSERANDBENCHMARK
    • LM
    • LMMOBILE
    • LMMONITOR
    • LMTRANSACTION
    • MOBILE
    • PP
    • PPMOBILE
    • PPMONITOR
    • PPTRANSACTION
    • STREAM
    • TRANSACTION
    • TRANSACTIONBENCHMARK
    • TRANSACTIONANDBENCHMARK
    • UTATX
    • UTATXANDBENCHMARK
    • UTATXBENCHMARK
  • sStatusDesignator - Indicate the status of the tests to retrieve:
    • ALL
    • ACTIVE
    • INACTIVE

Validation criteria

  • sUsername is valid for an account.
  • sPassword is valid for the specified username.
  • sMonitorSetDesignator is valid for the type of tests created for your account.
  • sStatusDesignator is valid for the status of the tests to retrieve.

For more information, see Retrieving Specific Account Management Data.

Response XML

STATUS_FAILED

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

<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>
    <GetAccountMonitorsResponse
       xmlns="http://gomeznetworks.com/webservices/">
    <GetAccountMonitorsResult>
     <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>
    </GetAccountMonitorsResult>
  </GetAccountMonitorsResponse>
 </soap:Body>
</soap:Envelope>

SUCCESS

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

<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>
   <GetAccountMonitorsResponse
     xmlns="http://gomeznetworks.com/webservices/">
    <GetAccountMonitorsResult>
      <Status>
        <eStatus>STATUS_SUCCESS</eStatus>
        <sErrorMessage>string</sErrorMessage>
      </Status>
    <MonitorSet>
     <Monitor mid="1162745" desc="yoohoo_single_URL"
       url="http://www.yoohoo.com" class="MONITOR"
       status="INACTIVE" account="12102"
       timeoutinsec="300" frequencyinms="300"
       docomponents="1" created="5/19/2012 3:22:55 PM"
       modified="5/3/2014 2:01:09 PM" isBrowser="false"
       isMobile="false" />
     <Monitor mid="1162690" desc="yoohoo_transaction_all"
       url="" class="TRANSACTION" status="ACTIVE"
       account="12102" timeoutinsec="300" frequencyinms="300"
       docomponents="1" created="5/19/2012 2:37:47 PM"
       modified="5/3/2014 1:52:50 PM" isBrowser="false"
       isMobile="false" />
    </MonitorSet>
   </GetAccountMonitorsResult>
  </GetAccountMonitorsResponse>
 </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. Retrieve the WDSL for the complete definition of this XML response. For more information, see Retrieving Account Management Data.

Attribute Description Parent Element Child Elements
<GetAccountMonitorsResult> 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 <GetAccountMonitorsResult> <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 account monitor information <GetAccountMonitorsResult> <Monitor>
<Monitor> The container for information about 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    
isBrowser Indicates if the test is a browser test (True or False).    
isMobile Indicates if the test is a mobile test (True or False).    
<MbgMonitorSet> The container for the MBG monitor set <GetAccountMonitorsResult> <MbgMonitor>
<MbgMonitor> The container for the particular test <MbgMonitorSet>  
id The ID of the MBG monitor    
groupid The ID of the group    
mid The monitor’s ID    
status ACTIVE or INACTIVE    

Other SOAP and HTTP examples

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