XML Report Service (XRS) provides a reporting framework for customers with a
need to display real-time monitoring information about their devices right
within their applications or web sites in a custom format. Some examples of
usage could include ISPs providing independent uptime, performance and
up-to-minute status of the services to their customers via web site. Another
example would be a Data Center integrating monitoring data within their
internal applications.
XRS service provided free of charge. The only requirement is that you must
display the following message on the page or application that uses our data:
"This data is provided by external web site monitoring service:
www.dotcom-monitor.com". Or you can place one of the stamps located here
http://www.dotcom-monitor.com/stamps.asp on the page where data is displayed.
XRS provides APIs to real-time data via HTTP request. Developer would structure
the correct HTTP GET Request to xmlreporter.dotcom-monitor.com service and in
return XRS would output XML document. In most cases the XML data would have to
be formatted and then could be presented to the end-user in any form.
Here are the few examples:
http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78789A2394764BA880A4DCAC62AAE90D&Site=14721&Type=Detail
http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78789A2394764BA880A4DCAC62AAE90D&Site=14721&Type=Detail&Type=Week
Here is the description for all available options:
Responses.aspx?
| PID=<Client UID> |
This is client Global Unique Identifier. This ID is located under
"Global Settings" menu. |
|
|
| Site=<Site1>&..&Site=<SiteN> OR Site=* - Sites list
|
This is a list of Sites ID's. Also called "Devices" in dotcom-monitor.com. To
get site ID please see the usage of config.aspx below. You can output multiple
sites in one report. Use * to select all the sites. |
|
|
| Task=<Task1>&..&Task=<TaskN> OR Task=* - Tasks list |
Same as site. This is an ID of tasks. You can output multiple tasks in one
report. Use * to select all the tasks. |
|
|
| Type=Overall |
This will provide summary data, such as uptime/downtime, number of successes
and number of failures, performance data and standard deviation. |
|
|
| Type=Day |
Include summary by days for specified period |
|
|
| Type=Week |
Include summary by weeks for specified period |
|
|
| Type=Month |
Type=Month Include summary by month for specified period |
|
|
| Type=Year |
Include summary by year for specified period |
|
|
| Type=Detail |
This will provide raw data for requested period. Raw data is available only for
the last 60 days. |
|
|
| From=<DateAndTime> |
This specifies start date and time for reporting. |
|
|
| To=<DateAndTime>
|
This specifies end date and time for reporting. |
| PID=<Client UID> |
This is client Global Unique Identifier. This ID is located under
"Global Settings" menu. |
|
|
| SiteName=<SiteName1>&..&SiteName=<SiteNameN>
|
List of sites (also called devices). This parameter accepts wildcard characters
such as "*". To get list of all sites within account use
"SiteName=*" |
|
|
| TaskName=<TaskName1>&..&TaskName=<TaskNameN>- List of task
name with wildcard chars(*,?). |
List of tasks This parameter accepts wildcard characters such as "*".
To get list of all tasks under all devices within account use
"TaskName=*" |
|
|
| Type=Task |
This is only to be used with SiteName parameter. It provides task information
within selected sites |
|
|
| Type=Field |
Provides detailed information on task setup. |
