Request Parameters Description to Pull Real-time XML Reports

• http://xmlreporter.dotcom-monitor.com/reporting/xml/Account.aspx

This URL will return the utilization history for the selected account with a breakdown by solutions. The report includes information on package capacity and used resources per package. For root accounts with Departments, the Departments’ package utilization will be included.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

To pull a report on a particular department, login to the department and add a new integration with the XML Feed integration type. Then use this XML Feed UID as XML Feed UID in the PID parameter.

Examples:

https://xmlreporter.dotcom-monitor.com/reporting/xml/Account.aspx?PID=78799A2394884BA880A4DCAC62AAE90D

• OutputFormat=json

Use in the query to pull the report in JSON format.

This base URL allows you to retrieve site and task details.

• https://xmlreporter.dotcom-monitor.com/reporting/xml/config.aspx

Using this base URL you can pass a number of parameters in the request, as detailed below in the list of parameters.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

For a root account, if you need to pull a report on a particular department or several departments, create an XML Feed Integration and select the Allow access to the department’s data option. Use the UID of the XML Feed (with access to the department data) Integration in conjunction with the Department parameter in request parameters.

• Department=<Department Id1>&..&Department=<Department IdN>

Only in conjunction with the XML Feed UID with enabled access to the department data. You can find your Department IDs under Account Settings > Departments.

Example: 

This request will return the XML with details on all sites and devices broken down by departments with the specified IDs:

https://xmlreporter.dotcom-monitor.com/reporting/xml/config.aspx?PID=F8F97FD1B7440685F747096B6FFB80&Department=59069&Department=97895&SiteName=*

• Tag=<Tag1>&..&Tag=<TagN> 

This parameter pulls all sites and tasks with at least one tag from the list.

• SiteName=<SiteName1>&..&SiteName=<SiteNameN>

This is a list of the site (so-called “Device”) names in Dotcom-Monitor. You can use wildcard characters (“*”, “?”) to filter request results by some name pattern:

SiteName=goo*

Use “*” to select all the sites:

SiteName=*

• Task=<Task1>&..&Task=<TaskN>

This is an ID of a monitoring task in Dotcom-Monitor, similar in structure to the Site parameter. You can output multiple tasks in one request and use wildcard characters (“*”, “?”) to filter request results by some task ID pattern.

Use “*” to select all the tasks:

Task=*

Individual Task IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected task. When the next screen loads, the Task ID will be in the URL as such:

https://user.dotcom-monitor.com/task-edit.aspx?id=123456

You can also get the task ID with the config.aspx request using the XML interface.

• Type=Task

Includes task basic information.

• Type=Field

Includes task detailed information.

• OutputFormat=json

Use in the query to pull the report in JSON format.

Examples:

https://xmlreporter.dotcom-monitor.com/reporting/xml/config.aspx?PID=78799A2394884BA880A4DCAC62AAE90D&SiteName=*&Type=Task&Type=Field

• http://xmlreporter.dotcom-monitor.com/reporting/xml/status_v1.aspx

This will simply return statuses of the requested devices. Please see a dtailed description of the device statuses in the Device States Explained article of our wiki.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

For a root account, if you need to pull a report on a particular department or several departments, create an XML Feed Integration and select the Allow access to the department’s data option. Use the UID of this XML Feed (with access to the department data) Integration in conjunction with the Department parameter in request parameters.

• Department=<Department Id1>&..&Department=<Department IdN>

Only in conjunction with the XML Feed UID with enabled access to the department data. You can find your Department IDs under Account Settings > Departments.

Example: 

This request will return the XML with statuses on the sites and devices created within the department with the specified ID:

https://xmlreporter.dotcom-monitor.com/reporting/xml/status_v1.aspx?PID=78799A2394884BA880A4DCAC62AAE90D&Department=123777&Site=*

• Tag=<Tag1>&..&Tag=<TagN> 

This parameter pulls all sites and tasks with at least one tag from the list.

• Site=<Site1>&..&Site=<SiteN> 

This is a list of the site (so-called “Devices”) IDs or names in Dotcom-Monitor. You can output multiple sites in one request and use wildcard characters (“*”, “?”) to filter request results by some pattern:

SiteName=123*

Use “*” to select all the sites:

Site=*

Individual Site IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected device. When the next screen loads, the Site ID will be in the URL as such:

https://user.dotcom-monitor.com/Site-Edit.aspx?id=123456

You can also get a Site ID with the config.aspx request using the XML interface.

• OutputFormat=json

Use in the query to pull the report in JSON format.

Examples:

https://xmlreporter.dotcom-monitor.com/reporting/xml/status_v1.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Site=*

• http://xmlreporter.dotcom-monitor.com/reporting/xml/status.aspx

This will simply return the State of: Up/Down/Postponed and the status of Active/Postponed/NoTasks for the requested devices.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

For a root account, if you need to pull a report on a particular department or several departments, create an XML Feed Integration and select the Allow access to the department’s data option. Use the UID of this XML Feed (with access to the department data) Integration in conjunction with the Department parameter in request parameters.

• Department=<Department Id1>&..&Department=<Department IdN>

Only in conjunction with the XML Feed UID with enabled access to the department data. You can find your Department IDs under Account Settings > Departments.

Example: 

This request will return the XML with statuses on the sites and devices created within the department with the specified ID:

https://xmlreporter.dotcom-monitor.com/reporting/xml/status.aspx?PID=78799A2394884BA880A4DCAC62AAE90D&Department=123777&Site=*

• Tag=<Tag1>&..&Tag=<TagN> 

This parameter pulls all sites and tasks with at least one tag from the list.

• Site=<Site1>&..&Site=<SiteN> 

This is a list of the site (so-called “Devices”) IDs or names in Dotcom-Monitor. You can output multiple sites in one request and use wildcard characters (“*”, “?”) to filter request results by some pattern:

SiteName=123*

Use “*” to select all the sites:

Site=*

Individual Site IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected device. When the next screen loads, the Site ID will be in the URL as such:

https://user.dotcom-monitor.com/Site-Edit.aspx?id=123456

You can also get a Site ID with the config.aspx request using the XML interface.

• OutputFormat=json

Use in the query to pull the report in JSON format.

Examples:

https://xmlreporter.dotcom-monitor.com/reporting/xml/status.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Site=*

• http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx

This base URL is used to pass a number of parameters in the request, as detailed below in the list of parameters.

Be sure to remove any spaces between parameters. Otherwise, the XML feed will ignore those parameters.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

For a root account, if you need to pull a report on a particular department or several departments, create an XML Feed Integration and select the Allow access to the department’s data option. Use the UID of this XML Feed (with access to the department’s data) Integration in conjunction with the Department parameter in request parameters.

• Department=<Department Id1>&..&Department=<Department IdN>

Only in conjunction with the XML Feed UID with enabled access to the department’s data. You can find your Department IDs under Account Settings > Departments.

Example: 

This request will return the XML with summary data on all sites and devices created within the department with the specified ID:

https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Department=123777&Site=*&Type=Overall

• Tag=<Tag1>&..&Tag=<TagN> 

This parameter pulls all sites and tasks with at least one tag from the list.

• Site=<Site1>&..&Site=<SiteN> 

This is a list of the site (so-called “Devices”) IDs or names in Dotcom-Monitor. You can output multiple sites in one request and use wildcard characters (“*”, “?”) to filter request results by some pattern:

SiteName=123*

Use “*” to select all the sites:

Site=*

Individual Site IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected device. When the next screen loads, the Site ID will be in the URL as such:

https://user.dotcom-monitor.com/Site-Edit.aspx?id=123456

You can also get a Site ID with the config.aspx request using the XML interface.

• Task=<Task1>&..&Task=<TaskN>

This is an ID of a monitoring task in Dotcom-Monitor, similar in structure to the Site parameter. You can output multiple tasks in one request and use wildcard characters (“*”, “?”) to filter request results by some task ID pattern.

Use “*” to select all the tasks:

Task=*

Individual Task IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected task.  When the next screen loads, the Task ID will be in the URL as such:

https://user.dotcom-monitor.com/task-edit.aspx?id=123456

You can also get the task ID with the config.aspx request using the XML interface.

There are several optional parameters that can be appended to the URL using the &, particularly when polling for responses with the base URL of http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx:

• Type=Overall

This will provide summary data, such as uptime/downtime, number of successes, number of failures, performance data, and standard deviation.

• Type=Hour

This parameter will aggregate responses into hour-long periods and display statistical information for each hour.

• Type=Day
  

Include a summary by days for a specified period.

• Type=Week

Include a summary by week for the specified period.

• Type=Quarter

This parameter breaks a period into a 3-month (Quarter) period and each “</Summary> … </Summary>” element represents statistical data calculated over a 3-month period.

• Type=Month

Month= summary by month for a specified period.

• Type=Year

Year=summary by year for a specified period.

• Type=Detail

It provides raw data for a requested period. Raw data is available only for the last 6 months.

• Startofweek=<Monday>
  

Allows the user to shift the start day of a business week. For example, you can set the day to start to a Sunday, like in the US (Startofweek=Sunday), or Monday like in the EU (Startofweek=Monday)

• From=<DateAndTime>

This specifies the start date and time for reporting.

For US date and time format, use slashes “MM/DD/YYYY H:M:S AM(PM)
For EU date and time format, use dashes “YYYY-MM-DD H:M:S”

• To=<DateAndTime>

This specifies an end date and time for reporting.
For US date and time format, use slashes “MM/DD/YYYY H:M:S AM(PM)”
For EU date and time format, use dashes “YYYY-MM-DD H:M:S”

http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Site=70795&Type=overall&from=09/13/2012&to=09/13/2012

http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Site=59106&Type=Detail&from=2012-03-04 15:20:30&to=2012-03-05 15:20:30

• Type = Hourofday

This parameter gives responses containing 24 numbered pieces, where each “</Summary> … </Summary>” element matches one exact hour in a day. Statistical Values (like Average Response Time, Response Time STDDev, Downtime Percentage, etc.) reflect averages calculated over a specified period (for example, a week period). This parameter is convenient for the analysis of the hourly load.

This type works only for reporting periods longer or equal to 1 day.

• Type = StatusChange
  

Statistical information is calculated for each block, which corresponds to the length of time after any change of status. This parameter will make “</Summary> … </Summary>” elements display periods in the same way as in “Uptime/Downtime periods” section of any online report.

• Type = DayOfWeek

This parameter provides a response containing seven (7) numbered pieces, where each “</Summary> … </Summary>” element matches one exact day in a week. Statistical Values (like Average Response Time, Response Time STDDev, Downtime Percentage, etc.) reflect averages calculated over a specified period (for example, a week period) for a day. This parameter is convenient for the analysis of the daily load.

• Filter=<FilterID>

This provides the ability to filter your data in compliance with the filter’s rules.

Individual Filter IDs can be found when logged in to your account on the Device Manager screen in the navigation menu under Manage, Filters.  When you click on a filter you will see the ID in the URL of the edit page:

https://user.dotcom-monitor.com/Filter-Edit.aspx?id=123456

• Scheduler=<SchedulerID>

This provides the ability to exclude data for a specific period of time.

Individual Schedule IDs can be found when logged in to your account on the Device Manager screen in the navigation menu under Manage, Schedules.  when you click on a filter you will see the ID in the URL of the edit page:

https://user.dotcom-monitor.com/Scheduler-Edit.aspx?id=123456

• Status=S

View successful responses only.

• Status=F

View failure responses only.

• Location=[agent1]&…&Location=[agent2]

Filter responses by monitoring agent locations.

If you want the XML Feed to show results only from certain monitoring agents, add “&Location” string parameter to the request URL in the following way:

http://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=XXXXXXXXXXX&Site=XXXXX&Type=Detail &Location=[agent1]&Location=[agent2]...&Location=[agent5]...

For agents’ string values, please check the XML String column of the Network Location IP Addresses table on our website.

• Options=Comments

Include custom comments associated with a device.

• Options=RequestDetails

To include element-level details (as included in a waterfall chart), you can set the Options flag to RequestDetails.

Include “Extended XML details”.

• Options=AllDownPercentages

Include all the percentages of the summary.

• Options=AllTimes

Include all times of summary including the uptime, downtime, undefined time, weighted uptime and weighted downtime.

• Options=LatestResponses

Include the most recent response from every monitoring location assigned to the selected devices.

• Amount=<number>

Include only set <number> of the last responses for the selected devices.

• Details=Content

Include Hitdetail Content.

• Details=HtmlBody

Include Hitdetail HtmlBody

• Details=CommonDescription

Include Hitdetail CommonDescription

• Details=BrowserAction

Includes navigation timings such as Navigation Start / End, Redirect, Fetch, Domain Lookup, Request Start, Unload Event, Render Start.

• OutputFormat=json

Use in the query to pull the report in JSON format.

Examples:

https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Site=*&Type=Overall
https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&Task=*&Type=Detail

• http://xmlreporter.dotcom-monitor.com/reporting/xml/NotificationLog.aspx

This base URL is used to pass a number of parameters in the request, as detailed below in the list of parameters.

Be sure to remove any spaces between parameters. Otherwise, the XML feed will ignore those parameters.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

• SiteName=<SiteName1>&..&SiteName=<SiteNameN>

Use this parameter to pass a device name in Dotcom-Monitor or a list of devices you want to receive a notification log for. You can use wildcard characters (“*”, “?”) to filter request results by a name pattern:

SiteName=goo*

Use “*” to receive a notification log for all the devices from your Dotcom-Monitor account:

SiteName=*

For a root account, if you need to pull a report on a particular department or several departments, create an XML Feed Integration and select the Allow access to the department’s data option. Use the UID of the XML Feed (with access to the department data) Integration in conjunction with the Department parameter in request parameters.

• Department=<Department Id1>&..&Department=<Department IdN>

Only in conjunction with the XML Feed UID with enabled access to the department data. You can find your Department IDs under Account Settings > Departments.

Example: 

This request will return the XML with details on all sites and devices broken down by departments with the specified IDs:

https://xmlreporter.dotcom-monitor.com/reporting/xml/NotificationLog.aspx?PID=F8F97FD1B7440685F747096B6FFB80&Department=59069&Department=97895&SiteName=*

• Task=<Task1>&..&Task=<TaskN>

This is an ID of a monitoring task in Dotcom-Monitor, similar in structure to the SiteName parameter. You can pull notification logs for multiple tasks in one request and use wildcard characters (“*”, “?”) to filter request results by a task ID pattern.

Use “*” to select all the tasks:

Task=*

Individual Task IDs can be found when logged in to your account on the Device Manager screen by clicking edit in the action menu next to the selected task. When the next screen loads, the Task ID will be in the URL as such:

https://user.dotcom-monitor.com/task-edit.aspx?id=123456

You can also get the task ID with the config.aspx request using the XML interface.

• From=<DateAndTime>

This parameter specifies the start date and time for notifications to be shown in the report.

For US date and time format, use slashes “MM/DD/YYYY H:M:S AM(PM)
For EU date and time format, use dashes “YYYY-MM-DD H:M:S”

• To=<DateAndTime>

This parameter specifies the end date and time for reporting.

For US date and time format, use slashes “MM/DD/YYYY H:M:S AM(PM)”
For EU date and time format, use dashes “YYYY-MM-DD H:M:S”

http://xmlreporter.dotcom-monitor.com/reporting/xml/NotificationLog.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&SiteName=70795&from=05/13/2022&to=06/13/2022

http://xmlreporter.dotcom-monitor.com/reporting/xml/NotificationLog.aspx?pid=78799A2394884BA880A4DCAC62AAE90D&SiteName=59106&from=2022-03-04 15:20:30&to=2022-03-05 15:20:30

• OutputFormat=json

Use in the query to pull the report in JSON format.

Example request:

https://xmlreporter.dotcom-monitor.com/reporting/xml/NotificationLog.aspx?PID=D90A483EE45AD97A4B2FE49878235&SiteName=*&from=06/20/2022&to=06/21/2022

• http://xmlreporter.dotcom-monitor.com/reporting/xml/agents.aspx

This URL will return the list of monitoring locations that are available in the account including Private agents. The report includes information on location names, descriptions, and geo coordinates.

Query Parameters

• PID=<XML Feed UID>

This is your Account Unique Identifier for your XML Feed. You can create a new integration for XML Feed or select an existing UID for the XML Feed integration type under Manage > Integrations.

Example Request:

https://xmlreporter.dotcom-monitor.com/reporting/xml/agents.aspx?PID=78799A2394884BA880A4DCAC62AAE90D

• Department=<Department Id1>&..&Department=<Department IdN>

If your account contains Departments, you can include the list of Private Agents exclusively used by a specific department or several departments in the report. To do this:

1. Create a new XML Feed Integration with the activated Allow access to the department’s data option.
2. Use the UID of the XML Feed (with access to the department data) in the PID parameter.
3. Specify the department IDs in the Department query parameter. You can find your department IDs under Account Settings > Departments.

• OutputFormat=json

Use in the query to pull the report in JSON format.

Example Request: 

This request will return the XML with details on all monitoring agents used by the company’s main account and departments with the specified IDs:

https://xmlreporter.dotcom-monitor.com/reporting/xml/agents.aspx?PID=F8F97FD1B7440685F747096B6FFB80&Department=59069&Department=97895

Example Report: