Super Monitoring API - Super Monitoring for your website

« back to feature list

Super Monitoring API 1.1 Documentation

Super Monitoring API allows retrieving historical monitoring data from www.supermonitoring.com.

1. Authentication

Super Monitoring API uses API Key to allow access to the API.
API Key is issued only for a specific IP address, that requests are going to come from.
Please contact Super Monitoring Support to obtain your API Key.

1.1. Response Codes & Texts

Super Monitoring API returns status codes together with short captions.

ResponseCode	ResponseText	Description
01	OK	Authentication successful.
10	AUTH FAILED	Authentication failed. Provided apikey was invalid or the request came from a different IP address that the apikey had been generated for.
11	URL NOT FOUND	No check for given URL has been found on user account. Hint: Make sure the URL is encoded and doesn't include "http://" or "https://".
12	INCORRECT DATE RANGE	Date & time in the "from" parameter is not earlier than the one in the "to" parameter - or one of the dates & time is not formatted properly.
13	SERVICE BLOCKED	The check or the account is inactive.
14	RANGE LIMIT EXCEEDED	The given time range is larger than 1 year.

1.2. Example Response

Example: Authorization unsuccessful.

{
  "ResponseCode":10,
  "ResponseText":"AUTH FAILED",
  "Host":"78.10.233.131"
}

2. Getting the list of checks.

2.1. HTTP Request

Method	URL
GET	https://www.supermonitoring.com/API/1.1/checks/

2.2. Query Parameters

Parameter	Required	Description	Opis
apikey	yes	-	The API Key. Example: "4grf647e4tyrfg43663f"

2.3. Example Query

https://www.supermonitoring.com/API/1.1/checks/?apikey=4grf647e4tyrfg43663f

2.4. Response Format

Super Monitoring API responses come back as JSON.

Property Name	Description
ResponseCode	Response status code - see below.
ResponseText	Response status description - see below.
Host	IP address the query was sent from (for reference).
X	Check number.
id	Check unique ID.
proto	Protocol / port number of the monitored host. Possible values: - "http" - "https" - "ftp" - "pop3" - "smtp" - "imap" - "telnet" - "ssh" - "dns" - "connect" - "sip" - "ping" - "MySQL" - "MSSQL" - "PostgreSQL"
url	URL address of the monitored object, without its protocol prefix.
type	Check type. Possible values: - "availability" - "content" - "form" - "loading_time" - "file_integrity" - "transaction" - "daily_health" - "core_web_vitals" - "change"
active	Check status. Possible values: - "0" - inactive - "1" - active.

2.5. Example Response

Example: List of checks.

{
   "ResponseCode":"01",
   "ResponseText":"OK",
   "Host":"78.10.233.131",
   "1":{
      "id":"2442",
      "proto":"http",
      "url":"www.mywebsite.com",
      "type":"availability",
      "active":1
   },
   "2":{
      "id":"2453",
      "proto":"https",
      "url":"www.otherwebsite.com/offer",
      "type":"content",
      "active":1
   },
   "3":{
      "id":"4099",
      "proto":"https",
      "url":"www.another-website.com",
      "type":"loading_time",
      "active":0
   }
}

3. Getting the failure events for a specific check.

3.1. HTTP Request

Method	URL
GET	https://www.supermonitoring.com/API/1.1/

3.2. Query Parameters

Parameter	Required	Default	Description
apikey	yes	-	The API Key. Example: "4grf647e4tyrfg43663f"
url	yes	-	Encoded URL of the check, without "http://" or "https://". Example: "www.mywebsite.com%2Ffolder"
from	yes	-	Starting date of the time range, using the time zone of the account. Format: YYYY-MM-DD-HH-MM Example: "2016-01-01-00-00"
to	yes	-	Ending date of the time range, using the time zone of the account. Format: YYYY-MM-DD-HH-MM The time range is limited to maximum 1 year. Example: "2016-01-26-23-59"
type	no	s	If set to "s" (or omitted) the result will include only a summary. If set to "d" the result will include a summary plus a detailed list of outages. Example: "s"

3.3. Example Queries

Example 1

http://www.supermonitoring.com/API/1.1/?apikey=4grf647e4tyrfg43663f&url=www.mywebsite.com%2Ffolder&from=2016-01-01-00-00&to=2016-01-26-23-59&type=s

Example 2

http://www.supermonitoring.com/API/1.1/?apikey=4grf647e4tyrfg43663f&url=www.mywebsite.com%2Ffolder&from=2016-01-01-00-00&to=2016-01-26-23-59&type=d

3.4. Response Format

Super Monitoring API responses come back as JSON.

Property Name	Description
ResponseCode	Response status code - see below.
ResponseText	Response status description - see below.
Host	IP address the query was sent from (for reference).
Outages	Total number of outages in the specified time range.
Downtime	Total downtime (in minutes) in the specified time range.
Events	Detailed list of outages from the specified time range.
eventID	Outage unique ID.
eventStart	Outage detection date & time, using the time zone of the account. Format: YYYY-MM-DD HH:MM
eventDuration	Outage duration (in minutes).
eventError	Failure type. Possible failure types: - http error codes, for example "HTTP 503" - "CONNECTION TIMEOUT" - "PING TIMEOUT" - "PAGE LOADING TIMEOUT" - "NOPHRASE" - "NOPHRASE FORM" - "CHECKSUM" - "PROCESS" - "DOMAIN EXPIRED" - "BLACKLISTED (GOOGLE)" - "BLACKLISTED (RBL)" - "INVALID SSL CERT." - "SSL CERT. EXPIRED" - "ROBOTS BLOCKED" - Core Web Vitals threshold exceeded, e.g. "Field LCP: 4.03s" - "CHANGE DETECTED" - "CHANGE - ELEMENT NOT FOUND"

3.5. Example Responses

Example 1: Summary.

{
  "ResponseCode":"01",
  "ResponseText":"OK",
  "Host":"78.10.233.131",
  "Outages":12,
  "Downtime":142
}

Example 2: Summary + Detailed List.

{
  "ResponseCode":"01",
  "ResponseText":"OK",
  "Host":"78.10.233.131",
  "Outages":12,
  "Downtime":142,
  "Events":
    [
      {
        "eventID":"365257",
        "eventStart":"2016-01-04 10:54:47",
        "eventDuration":"8",
        "eventError":"HTTP 503"
      },
      {
        "eventID":"365287",
        "eventStart":"2016-01-04 14:18:48",
        "eventDuration":"1",
        "eventError":"CONNECTION TIMEOUT"
      },
      {
        "eventID":"366191",
        "eventStart":"2016-01-09 08:26:47",
        "eventDuration":"3",
        "eventError":"HTTP 503"
      },
      {
        "eventID":"368393",
        "eventStart":"2016-01-22 12:00:48",
        "eventDuration":"1",
        "eventError":"HTTP 500"
      }
    ]
}