To find more information about filters and filtering in Dotcom-Monitor, please visit the Setting Up Filters section of our Knowledge Base.

Available Methods

Connection Sample

Example JSON Object
{
    "Name": "4 locations",
    "Id": 1093,
    "Description": "4 locations Filter",
    "Rules": 
    {
        "Time_Min": 5,
        "Number_Of_Locations": 4,
        "Number_Of_Tasks": 1,
        "Owner_Device": false
    },
    "Items": 
    [
        {
            "Error_Type": "Http",
            "Error_Code_To_Ignore": [500]
        }, 
        {
            "Error_Type": "Tcp",
            "Error_Code_To_Ignore": [12501]
        }
    ],
    "Assigned_To": [8533, 8534,9756]
}

Fields Description

Field Type Description

Name

String

Filter name.

Example:
"Name""4 locations"

Id

Int32

Unique Filter ID

Example:
"Id": 1093

Description

String

Filter Description.

Example:
"Description""4 locations Filter"

Rules

Object

Possible Rules:

  • “Time_Min” defines duration of the reported error.
  • “Number_Of_Locations” defines number of monitoring locations which are sending error responses.
  • “Number_Of_Tasks” defines number failed tasks.
  • “Owner_Device” flag lets you enable, or disable verification if an Owner Device is DOWN.
Example:
"Rules": {
            "Time_Min": 5,
            "Number_Of_Locations": 4,
            "Number_Of_Tasks": 1,
            "Owner_Device"false
      }

Items

Array of objects

Ignore an Error Type with specific Error Codes.

Possible Error Types: Validation, Runtime, CustomScript, Certificate, Cryptographic, Tcp, Dns, Udp, Http, Ftp, Sftp, Smtp, Pop3, Imap, Icmp, IcmpV6, DnsBL, Media, Sip

Example:
"Items": [{
            "Error_Type""Http",
            "Error_Code_To_Ignore": [500]
      }, {
            "Error_Type""Tcp",
            "Error_Code_To_Ignore": [12501]
      }]

Assigned_To

Array of int32

This array contains the list of device IDs, to which the filter is assigned.

Example:
"Assigned_To": [8533, 8534,9756]