Retrieves a Monitor resource.

{
  "type": "object",
  "description": "The Monitor resource is a collection of services that monitor the presence and/or absence of pings, and follow sets of rules to dispatch or not dispatch alerts.",
  "required": [
    "monitorName",
    "monitorTypeCode",
    "partition",
    "timezoneCode"
  ],
  "properties": {
    "alertPayloadExtended": {
      "type": "string",
      "description": "Payload that must be sent in the body of each alert when you use your own email or webhook alert services. This is the body for email alerts and the request body for webhook alerts. This text is not sent when using the built-in alert services. Sending user-supplied text via our own email server is too big a risk to our email reputation. Max 2 MB characters."
    },
    "alertPayloadShort": {
      "type": "string",
      "description": "Payload that must be sent in the body of each alert when you use your own short message alert services. This also serves as the subject for email alerts. Not used for webhooks. This text is not sent when using the built-in alert services. Sending user-supplied text via our own email server is too big a risk to our email reputation. Max 100 characters."
    },
    "alertServices": {
      "type": "array",
      "description": "The alert services that are related to this resource.",
      "items": {
        "type": "string",
        "format": "iri-reference"
      }
    },
    "allowUnauthenticatedPings": {
      "type": "boolean",
      "description": "Indicates that the monitor will accept pings that are not OAuth authenticated."
    },
    "contentCheckMustNotExist": {
      "type": "boolean",
      "description": "Indicates that the Web Content monitor must verify the absence of the text or the Xpath node, and dispatch an alert if it is present. The default behavior is to verify the presence of the text or the Xpath node, and dispatch an alert if it is absent."
    },
    "contentCheckText": {
      "type": "string",
      "description": "The text (case-insensitive) that must or must not be present at the contentCheckUrl. If contentCheckXpathFilter is supplied, then the only the text within that nodes is evaluated, otherwise text on the entire web page is evaluated."
    },
    "contentCheckUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL that the Web Content monitor type must evaluate for the specified conditions."
    },
    "contentCheckXpathFilter": {
      "type": "string",
      "description": "The Xpath filter (<a href=\"https://en.wikipedia.org/wiki/XPath\">Xpath</a>, <a href=\"https://devhints.io/xpath\">Xpath Cheatsheet</a>) that selects a specific node in the HTML of the target web page. If contentCheckText is supplied, then only the text within the selected node is evaluated. If contentCheckText is left empty, then the presence or the absence of the selected node is evaluated."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the resource instance was created. This date-time is in the UTC timezone."
    },
    "dataSegmentCode": {
      "type": "string",
      "description": "User-provided string on which to segment and filter data. Max 50 characters."
    },
    "graceSeconds": {
      "type": "integer",
      "description": "The number of grace seconds after expiry of the time when the next ping was expected, before raising an alert. The number of grace seconds to allow before classifying a Measured Monitor task duration as an anomaly."
    },
    "humanizedInterval": {
      "type": "string",
      "description": "The expected ping / run interval of this monitor in human readable form."
    },
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier of the resource instance."
    },
    "internalMonitorName": {
      "type": "string",
      "description": "The internal name of the monitor. This name is used in alerts when you use the built-in alert services. Sending user-supplied text via our own email server is too big a risk to our email reputation. The monitorName field is used when you use your own alert services."
    },
    "intervalDays": {
      "type": "integer",
      "description": "The number of days in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "intervalHours": {
      "type": "integer",
      "description": "The number of hours in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "intervalMinutes": {
      "type": "integer",
      "description": "The number of minutes in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "intervalMonths": {
      "type": "integer",
      "description": "The number of months in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "intervalSeconds": {
      "type": "integer",
      "description": "The number of seconds in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "intervalYears": {
      "type": "integer",
      "description": "The number of years in the expected ping / run / measured / scheduled interval. Can be left blank. Can be specified together with any combination of the other interval fields."
    },
    "isMonitorPaused": {
      "type": "boolean",
      "description": "Indicates that the monitor is paused and will not send alerts."
    },
    "lastPingAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the last ping was received. This date-time is in the UTC timezone."
    },
    "monitorName": {
      "type": "string",
      "description": "The name of the monitor. Max 255 characters."
    },
    "monitorNotes": {
      "type": "string",
      "description": "Notes about the monitor. Max 10,000 characters. Formatting using Markdown is allowed. HTML will be removed."
    },
    "monitorStatusCode": {
      "type": "string",
      "format": "iri-reference",
      "description": "The status of the monitor."
    },
    "monitorTypeCode": {
      "type": "string",
      "format": "iri-reference",
      "description": "The type of the monitor."
    },
    "nextPingAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the next ping is expected. This date-time is in the UTC timezone."
    },
    "partition": {
      "type": "string",
      "format": "iri-reference",
      "description": "The partition that contains this resource instance. The resource cannot be moved to another partition."
    },
    "pingSecret": {
      "type": "string",
      "description": "A secret key that can be sent in the X_PING_SECRET HTTP request header of a ping for additional security. Sending the secret is recommended for unauthenticated ping requests. It is redundant for OAuth authenticated ping requests that have the \"Authorization: Bearer\" header."
    },
    "publicDescription": {
      "type": "string",
      "description": "A text description of the monitor that is accessible to unauthenticated users that receive an alert from the monitor. Formatting using Markdown is allowed. HTML will be removed."
    },
    "resourceOwner": {
      "type": "string",
      "description": "The name of the person who owns this resource."
    },
    "startMonitorAt": {
      "type": "string",
      "format": "date-time",
      "description": "When to start the Regular Interval type monitor or Heartbeat type monitor, or when to send the first alert of the Scheduled Repeatable Alert monitor. Cannot be blank for a Regular Interval, Heartbeat, or Scheduled Repeatable Alert type monitor, must be blank for other monitors types. This date-time is always interpreted to be in the timezone of the monitor. Any UTC offset is ignored."
    },
    "startMonitorAtUtc": {
      "type": "string",
      "format": "date-time",
      "description": "The startMonitorAt date-time in the UTC timezone."
    },
    "systemMessages": {
      "type": "array",
      "description": "Service notes regarding the resource.",
      "items": {
        "type": "string"
      }
    },
    "timezoneCode": {
      "type": "string",
      "format": "iri-reference",
      "description": "The timezone of the monitor. Dates and times in alerts and reports will be in this time zone."
    },
    "webResponseSecondsLimit": {
      "type": "integer",
      "description": "The time in seconds that the Web Response monitor type must allow for the web page to respond."
    },
    "webResponseUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL that the Web Response monitor type must evaluate for the specified conditions."
    }
  }
}