Get Site Status Report

Last modified on July 26, 2024

Returns the Site Status report data for all monitors.

There are two versions of the Site Status report, XML (version 1) and JSON (version 2). The XML version returns a monitor status by individual locations, supports filters and subaccounts. The JSON version returns statuses of all monitors and does not support filters or subaccounts. For the JSON report that supports filtering, use report-sitestatus of AlertSite Management API.

XML Version

Request URL

GET https://www.alertsite.com/report-api/sitestatus/{customer-id}?[report_parameters]

Parameters

customer-id

Required. Your customer ID, such as C12345. You can find it on the  > Settings > Account screen in AlertSite UXM or on the Account > Manage Account screen in AlertSite 1.0.

In addition, the following optional query parameters are supported for the XML version:

enabledonly

1 – Include enabled monitors only.

0 – (Default) Include all monitors.

sitesonly

1 – Include website URL, API endpoint, email, FTP and network monitors only. This option, txnsonly=1, and serversonly=1 are mutually exclusive.

0 – (Default) Include all monitors.

txnsonly

1 – Include DéjàClick, Selenium and SoapUI monitors only. This option, sitesonly=1, and serversonly=1 are mutually exclusive.

0 – (Default) Include all monitors.

serversonly

1 – Include ServerAgents only. This option, sitesonly=1, and txnsonly=1 are mutually exclusive.

0 – (Default) Include all monitors.

showrecs

Filter the monitors and locations by the last observed status:

  • ok – Return only locations where the last test was OK (status 0).

  • err – Return only locations where the last test failed. Note that this includes “internal” errors 21, 90, 95, and 6061, which are not normally displayed on AlertSite dashboards.

  • If omitted or set to an empty string, all monitors and locations are included.

showsubaccounts

This parameter applies only to accounts with subaccounts.

1 – Also include subaccount monitors.

0 – (Default) Do not include subaccount monitors.

Response Body

XML

XML

<Status time="Tue Dec 12 12:26:53 2017 UTC" login="[email protected]" subaccounts="1">
  <Account company="AlertSite Demo" id="C12345" status="A" sites="2">
    <Device descrip="LuciernaBank" obj_device="123456" notify_content="n" notify="y" monitor="y" istxn="1" type="DejaClick" monitor_interval="5" port="" plandesc="UBM-Annual Contract/Annual Bill">
      <Location loc_descrip="Fort Lauderdale, FL" obj_location="10">
        <blackout_flag>0</blackout_flag>
        <blackouts_pending>0</blackouts_pending>
        <display_descrip>DejaClick: LuciernaBank</display_descrip>
        <dt_last_error/>
        <dt_last_scan/>
        <dt_last_status/>
        <dt_last_status_change>0</dt_last_status_change>
        <dt_last_status_fullpage/>
        <home_location>10</home_location>
        <info_msg/>
        <last_risk/>
        <last_status>0</last_status>
        <last_status_fp>0</last_status_fp>
        <last_status_warning/>
        <monitor_locs>0</monitor_locs>
        <resptime_last>0.00</resptime_last>
        <resptime_last_fp>0.00</resptime_last_fp>
      </Location>
      <Location loc_descrip="Atlanta, GA" obj_location="20">
        <blackout_flag>0</blackout_flag>
        <blackouts_pending>0</blackouts_pending>
        <display_descrip>DejaClick: LuciernaBank</display_descrip>
        <dt_last_error>2017-12-12 04:23:05</dt_last_error>
        <dt_last_scan/>
        <dt_last_status>2017-12-12 04:23:05</dt_last_status>
        <dt_last_status_change>1512390184</dt_last_status_change>
        <dt_last_status_fullpage>2017-12-12 04:23:05</dt_last_status_fullpage>
        <home_location>10</home_location>
        <info_msg/>
        <last_risk/>
        <last_status>1</last_status>
        <last_status_fp>0</last_status_fp>
        <last_status_warning>0</last_status_warning>
        <monitor_locs>0</monitor_locs>
        <resptime_last>0.00</resptime_last>
        <resptime_last_fp>0.00</resptime_last_fp>
      </Location>
    </Device>
    <Device descrip="https://example.com" obj_device="142688" notify_content="n" notify="n" monitor="n" istxn="0" type="Secure Web Site" monitor_interval="120" port="" plandesc="UBM-Annual Contract/Annual Bill">
      <Location loc_descrip="Stockholm, Sweden" obj_location="5110">
        <blackout_flag>0</blackout_flag>
        <blackouts_pending>0</blackouts_pending>
        <display_descrip>https://example.com</display_descrip>
        <dt_last_error/>
        <dt_last_scan/>
        <dt_last_status>2017-12-07 12:14:17</dt_last_status>
        <dt_last_status_change>1512484464</dt_last_status_change>
        <dt_last_status_fullpage/>
        <home_location>5110</home_location>
        <info_msg/>
        <last_risk/>
        <last_status>0</last_status>
        <last_status_fp/>
        <last_status_warning>9095</last_status_warning>
        <monitor_locs>1</monitor_locs>
        <resptime_last>0.00</resptime_last>
        <resptime_last_fp>0.00</resptime_last_fp>
      </Location>
    </Device>
  </Account>
  <Account company="Demo Subaccount" id="C54678" status="A" sites="1">
    <Device descrip="FTP test" obj_device="138050" notify_content="n" notify="y" monitor="y" istxn="0" type="FTP Server" monitor_interval="15" port="" plandesc="UBM-Annual Contract/Annual Bill">
      <Location loc_descrip="Boston, Massachusetts" obj_location="72">
        <blackout_flag>0</blackout_flag>
        <blackouts_pending>0</blackouts_pending>
        <display_descrip>FTP test</display_descrip>
        <dt_last_error>2017-12-07 07:31:58</dt_last_error>
        <dt_last_scan/>
        <dt_last_status>2017-12-07 07:31:58</dt_last_status>
        <dt_last_status_change>1511908493</dt_last_status_change>
        <dt_last_status_fullpage/>
        <home_location>72</home_location>
        <info_msg/>
        <last_risk/>
        <last_status>0</last_status>
        <last_status_fp/>
        <last_status_warning>0</last_status_warning>
        <monitor_locs>1</monitor_locs>
        <resptime_last>6.27</resptime_last>
        <resptime_last_fp>0.00</resptime_last_fp>
      </Location>
    </Device>
  </Account>
</Status>

If no matching results were found (for example, if mutually exclusive parameters were specified), the response looks like this:

XML

XML

<Status time="Tue Dec 12 12:47:09 2017 UTC" login="[email protected]">
  <Account company="AlertSite Demo" id="C12345" status="A" sites="0"/>
</Status>

JSON Version

Request URL

GET https://www.alertsite.com/report-api/sitestatus/{customer-id}?api_version=2&format=json

Parameters

The JSON version uses just the customer-id parameter and does not support other parameters available in the XML version.

Response Body

JSON

JSON

[
  {
    "monitor_interval": "10",
    "monitor": "y",
    "last_status": "0",
    "device_name": "LuciernaBank",
    "obj_cust": "12345",
    "recent_errors": "0",
    "device_type": "DejaClick",
    "obj_device": "123456",
    "dt_last_error": "2017-12-08 16:44:09",
    "resptime_last": "7.482692",
    "dt_last_status": "2017-12-12 06:54:12"
  },
  {
    "monitor_interval": "5",
    "monitor": "y",
    "last_status": "7",
    "device_name": "REST API - Echo",
    "obj_cust": "12345",
    "recent_errors": "0",
    "device_type": "Secure Web Site API",
    "obj_device": "144604",
    "dt_last_error": "2017-12-12 06:56:39",
    "resptime_last": "0.145",
    "dt_last_status": "2017-12-12 06:56:39"
  }
]

Examples

Get all monitor statuses in account C99999 as XML:

https://www.alertsite.com/report-api/sitestatus/C99999

Get all monitor statuses as JSON:

https://www.alertsite.com/report-api/sitestatus/C99999?api_version=2&format=json

Get location-specific monitor failures in account C99999 and subaccounts:

https://www.alertsite.com/report-api/sitestatus/C99999?showrecs=err&subaccounts=1

See Also

AlertSite Report API
Site Status Report

Highlight search results