GetCompleteAlertConfiguration (3.0)

This web method retrieves the complete alert configuration for all Backbone monitors of a specific type and having a specific status.

Request parameters

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

https://gpn.webservice.gomez.com/AlertManagementService30/AlertManagementWS.asmx/GetCompleteAlertConfiguration?username=string&password=string&monitorType=string&statusType=string

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

username – The Synthetic Classic account username
password – The Synthetic Classic account password
apitoken – The Synthetic Classic API token, used in lieu of username/password
monitorType – Specifies the class of Backbone monitor data to retrieve. Specify one of the following values:

Value	Description
ALL	To return information for all monitor types ('MONITOR', 'BROWSER TRANSACTION')
BROWSERTX	To return information for BROWSERTX tests only

statusType — Specifies the status of the monitor data to retrieve. Specify one of the following values:

Value	Description
ALL	To return both ACTIVE and INACTIVE tests
ACTIVE	To return only ACTIVE tests
INACTIVE	To return only INACTIVE tests

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.
apitoken is the Synthetic Classic API token, used in lieu of username/password.
monitorType specifies a valid monitor class.
statusType specifies a valid monitor status.

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>Invalid Account Specified</errorMessage>
</alertHistoryResponse>

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

Response XML: success

<alertConfigurationResponse xmlns="http://gomeznetworks.com/webservices/"
                            xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<status>SUCCESS</status>
	<monitorAlertConfiguration id="1162745" desc="yoohoo_single_URL"
       doSummary="false" doComponents="true" timeoutInSec="300"
       class="MONITOR" status="INACTIVE">
		<alertConfigurations>
			<PageHostAlert alertId="1" isEnabled="true" isPersistent="false">
		  		<siteThreshold type="PERCENT" value="3" />
			</PageHostAlert>
			<PageAccessibilityAlert alertId="2" isEnabled="true"
       isPersistent="false">
			  	<siteThreshold type="PERCENT" value="3" />
			</PageAccessibilityAlert>
			<PageObjectAlert alertId="3" isEnabled="true"
       isPersistent="false">
			 	 <siteThreshold type="PERCENT" value="3" />
				  <objectCountThreshold type="PERCENT" value="3" />
			</PageObjectAlert>
			<DynamicResponseTimeAlert alertId="5" isEnabled="true"
          isPersistent="false"
			       baselineResponseRangeInDays="1"
			       localResponseRangeInHours="5">
			 	<siteThreshold type="ABSOLUTEvalue=" 3 />
				 <warningThreshold type=PERCENT " value="5" />
				 <severeThreshold type="PERCENT" value="10" />
			</DynamicResponseTimeAlert>
			<ContentMatchAlert alertId="6" isEnabled="false"
        isPersistent="false">
				 <siteThreshold type="ABSOLUTE" value="0" />
			</ContentMatchAlert>
		</alertConfigurations>
	</monitorAlertConfiguration>
	<monitorAlertConfiguration id="1162690"
          desc="yoohoo_transaction_all" doSummary="false"
          doComponents="true" timeoutInSec="300"
          class="TRANSACTION"status="ACTIVE">
	<alertConfigurations>
			<PageObjectAlert alertId="3" isEnabled="true"
           isPersistent="true"
			        persistenceIntervalInMin="5">
				 <siteThreshold type="ABSOLUTE" value="1" />
				 <objectCountThreshold type="ABSOLUTE" value="1" />
			</PageObjectAlert>
			<TransactionAlert alertId="4" isEnabled="true"
           isPersistent="true"
			        persistenceIntervalInMin="5">
				 <siteThreshold type="ABSOLUTE" value="1" />
			</TransactionAlert>
			<DynamicResponseTimeAlert alertId="5" isEnabled="true"
          isPersistent="true"
			       persistenceIntervalInMin="5"
			       baselineResponseRangeInDays="1"
			       localResponseRangeInHours="5">
				 <siteThreshold type="ABSOLUTE" value="1" />
				 <warningThreshold type="PERCENT" value="5" />
				 <severeThreshold type="PERCENT" value="10" />
			</DynamicResponseTimeAlert>
			<ByteCountAlert alertId="7" isEnabled="false"
          isPersistent="true"
			       persistenceIntervalInMin="15">
				<siteThreshold type="ABSOLUTE" value="1" />
			</ByteCountAlert>
		</alertConfigurations>
	</monitorAlertConfiguration>
	<monitorAlertConfiguration status="ACTIVE"
          class="TRANSACTION" timeoutInSec="300"
	         doComponents="true" doSummary="false"
	         desc="TestLevel_Type5_DynSecs_MultipleIE" id="210482">
	 <alertConfigurations>
			<page pageSeqNum="0" url="http://www.google.com/">
				<pageAlertConfigurations>
					<PageLevelAvailabilityAlert
          persistenceIntervalInMin="15" isPersistent="true"
					     isEnabled="false" alertId="2004" pageSeqNum="0">
				 		<siteThreshold value="1" type="PERCENT" />
					</PageLevelAvailabilityAlert>
					<PageLevelDynamicResponseTimeAlert
          persistenceIntervalInMin="15"
					     isPersistent="true" isEnabled="true"
					     alertId="2005" localResponseRangeInMinutes="5"
					     baselineResponseRangeInDays="1" pageSeqNum="0">
					 	<siteThreshold value="1" type="ABSOLUTE" />
						 <warningThreshold value="25000" type="ABSOLUTE" />
						 <severeThreshold value="50000" type="ABSOLUTE" />
					</PageLevelDynamicResponseTimeAlert>
					<PageLevelStaticResponseTimeAlert persistenceIntervalInMin="5"
				      isPersistent="true" isEnabled="false"
					     alertId="2005" severeThresholdInMS="1000"
					     warningThresholdInMS="1000" pageSeqNum="0">
					 	<targets alertLevel="GOOD" alertLevelId="2">
						  	<smtpTarget status="ACTIVE"
							   subject="Test Network - PAGE - [$TestName$]
							          	- [$PageInfo$]
							           - [$AlertType$]
							           - [$AlertLevel$]
							           - [$AlertProgression$]"
							           addresses="john.doe@mycompany.com"
							           description="John_Plain_Page_Pager" targetId="426" />
					 	</targets>
						 <targets alertLevel="GOOD" alertLevelId="2">
							  <smtpTarget status="ACTIVE" subject="Test Network - PAGE
							           - [$TestName$]
							           - [$PageInfo$]
							           - [$AlertType$]
							           - [$AlertLevel$]
							           - [$AlertProgression$]"
							           addresses="john.doe@mycompany.com"
							           description="John_HTML_No_Links" targetId="427" />
						 </targets>
						 <targets alertLevel="WARNING" alertLevelId="4">
							  <smtpTarget status="ACTIVE"
							           subject="Test Network - PAGE - [$TestName$]
							           - [$PageInfo$] - [$AlertType$]
							           - [$AlertLevel$] - [$AlertProgression$]"
							           addresses="john.doe@mycompany.com"
							           description="John_HTML" targetId="424" />
						 </targets>
						 <siteThreshold value="1" type="PERCENT" />
					</PageLevelStaticResponseTimeAlert>
				</pageAlertConfigurations>
			</page>
			<page pageSeqNum="1" url="http://www.google.com/"/>
			<page pageSeqNum="2" url="http://www.google.com/"/>
			<page pageSeqNum="3" url="http://www.google.com/"/>
		</alertConfigurations>
	</monitorAlertConfiguration>
</alertConfigurationResponse>

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 and Child Element	Child Element
<alertConfigurationResponse>	Top-level container of the XML response of this web service	none	<status> <errorMessage> <monitorAlertConfiguration>
<status>	SUCCESS \| FAILED	<alertConfigurationResponse>	none
<errorMessage>	Detailed error message if status="FAILED"	<alertConfigurationResponse>	none
<monitorAlertConfiguration>	Container of monitor summaries and Synthetic Classic alert configurations associated with the monitor	<alertConfigurationResponse>	<alertConfigurations> <page>
id	Synthetic Classic monitor ID
desc	Synthetic Classic 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: MONITOR \| TRANSACTION
status	ACTIVE \| INACTIVE \| DELETE
<alertConfigurations>	Container for the collection of alert configurations for a given monitor	<monitorAlertConfiguration>	<PageHostAlert> <PageAccessibilityAlert> <PageObjectAlert> <TransactionAlert> <DynamicResponseTimeAlert> <ByteCountAlert> <ContentMatchAlert> <StaticResponseTimeAlert>
<PageHostAlert>	Container for user-defined page host alert configuration	<alertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<PageAccessibilityAlert>	Container for user-defined page accessibility alert configuration	<alertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<PageObjectAlert>	Container for user-defined page object count alert configuration	<alertConfigurations>	<objectCountThreshold> <targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<TransactionAlert>	Container for user-defined transaction alert configuration	<alertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<DynamicResponseTimeAlert>	Container for user-defined dynamic response time alert configuration	<alertConfigurations>	<warningThreshold> <severeThreshold> <targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
baselineResponseRangeInDays	User-defined duration in days over which the baseline response time average is calculated
localResponseRangeInHours	User-defined time duration in hours over which the local (or immediate) response time average is calculated
<ByteCountAlert>	Container for user-defined byte count alert configuration	<alertConfigurations>	<upperThreshold> <lowerThreshold> <targets> <siteThreshold>
alertId	Integral values correspond to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert
<ContentMatchAlert>	Container for user-defined content match alert configuration	<alertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<StaticResponseTimeAlert>	Container for user-defined static response time alert configuration	<alertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 1 — Page Host Alert (BROWSERTX) 2 — Page Inaccessible Alert (BROWSERTX) 3 — Page Object Alert (BROWSERTX) 4 — Transaction Failure Alert (BROWSERTX) 5 — Response Time Alert (BROWSERTX) 6 — Content Match Alert (BROWSERTX) 7 — Byte Limit Alert (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
warningThresholdInMS	User-defined response time warning threshold in milliseconds
severeThresholdInMS	User-defined response time severe threshold in milliseconds
<objectCountThreshold>	Container for user-defined threshold of page object count failures	<PageObjectAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, number of objects required to fail to trigger an alert If type=PERCENT, percentage of objects required to fail to trigger an alert
<warningThreshold>	Container for user-defined warning alert criteria	<DynamicResponseTimeAlert> <PageLevelDynamicResponseTimeAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, response time threshold in milliseconds to trigger an alert If type=PERCENT, percent of baseline response time required to trigger an alert
<severeThreshold>	Container for user-defined severe alert criteria	<DynamicResponseTimeAlert> <PageLevelDynamicResponseTimeAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, response time threshold in milliseconds to trigger an alert If type=PERCENT, percent of baseline response time required to trigger an alert
<upperThreshold>	Container for user-defined upper byte count threshold	<ByteCountAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, upper byte count threshold to trigger an alert If type=PERCENT, upper percent byte count threshold to trigger an alert
<lowerThreshold>	Container for user-defined lower byte count threshold	<ByteCountAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, lower byte count threshold to trigger an alert If type=PERCENT, lower percent byte count threshold to trigger an alert
<targets>	Container for targets of alert delivery	<PageHostAlert> <PageAccessibilityAlert> <PageObjectAlert> <TransactionAlert> <DynamicResponseTimeAlert> <ByteCountAlert> <ContentMatchAlert> <StaticResponseTimeAlert> <PageLevelAvailabilityAlert> <PageLevelDynamicResponseTimeAlert> <PageLevelStaticResponseTimeAlert>	<httpTarget> <smtpTarget>
alertLevelId Integral values representing the following alert levels: 1 – Unknown 2 – GOOD 3 – BAD 4 – WARNING 5 – SEVERE
alertLevel One of the following alert levels: Unknown GOOD BAD WARNING SEVERE
<siteThreshold>	Container for user-defined threshold of node failures	<PageHostAlert> <PageAccessibilityAlert> <PageObjectAlert> <TransactionAlert> <DynamicResponseTimeAlert> <ByteCountAlert> <ContentMatchAlert> <StaticResponseTimeAlert> <PageLevelAvailabilityAlert> <PageLevelDynamicResponseTimeAlert> <PageLevelStaticResponseTimeAlert>
type	ABSOLUTE \| PERCENT
value	If type=ABSOLUTE, number of failing nodes required to trigger an alert If type=PERCENT, percentage of failing nodes required to trigger an alert
<httpTarget>	Target to be delivered via HTTP POST	<targets>
targetId	Synthetic Classic target ID
description	User-defined target description
status	ACTIVE \| INACTIVE
url	User-defined endpoint for delivery of HTTP POST
<smtpTarget>	Target to be delivered via SMTP	<targets>
targetId	Synthetic Classic target ID
description	User-defined target description
status	ACTIVE \| INACTIVE
addresses	Semi-colon-delimited list of email addresses
subject	User-defined email subject that may contain substitution tokens
<page>	Container of page summaries and page alert configurations associated with the page	<monitorAlertConfiguration>	<pageAlertConfigurations>
pageSeqNum	Page number in the test
url	URL of the page
<pageAlertConfigurations>	Container for the collection of page alert configurations for a given page for a given monitor	<page>	<PageLevelAvailabilityAlert> <PageLevelDynamicResponseTimeAlert> <PageLevelStaticResponseTimeAlert>
<PageLevelAvailabilityAlert>	Container for user-defined page availability alert configuration	<pageAlertConfigurations>	<targets> <siteThreshold>
alertId	Integral value corresponding to the following alert types: 2004- Page Transaction Failure(BROWSERTX) 2005- Page Response Time(BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
pageSeqNum	Page number of the test
<PageLevelDynamicResponseTimeAlert>	Container for page dynamic response time alert configuration	<pageAlertConfigurations>	<targets> <siteThreshold> <warningThreshold> <severeThreshold>
pageSeqNum	Page number of the test
baselineResponseRangeInDays	User-defined duration in days over which the baseline response time average is calculated
localResponseRangeInHours	User-defined time duration in hours over which the local (or immediate) response time average is calculated
alertId	Integral value corresponding to the following alert types: 2004- Page Transaction Failure (BROWSERTX) 2005- Page Response Time (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends
<PageLevelStaticResponseTimeAlert>	Containerfor page static response time alert configuration	<pageAlertConfigurations>	<targets> <siteThreshold> <warningThreshold> <severeThreshold>
pageSeqNum	Page number of the test
warningThresholdInMS	User-defined response time warning threshold in milliseconds
severeThresholdInMS	User-defined response time severe threshold in milliseconds
alertId	Integral value corresponding to the following alert types: 2004- Page Transaction Failure (BROWSERTX) 2005- Page Response Time (BROWSERTX)
isEnabled	TRUE, if alert is enabled; FALSE, otherwise
isPersistent	TRUE, if alert is persistent; FALSE, otherwise
persistenceIntervalInMin	If isPersistent=TRUE, interval of time between alert sends