WebMonitoringResponse

Successful response with one WebMonitoring

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Monitoring of a website: checks of the availability of the domain, and notices

web_monitoring_idintegerrequired

purchase_idinteger | nullnullablerequired

Id of the purchase of the monitoring (GET /api/v3/purchases/{purchase_id})

service_namestring | nullnullablerequired

Name of the service of the purchase

purchase_namestring | nullnullablerequired

Name of the object of the purchase: the monitored domain

purchase_status_codestring | nullnullablerequired

Status code of the purchase, for example ACTIVE_V2 or DISMISSED_V2

monitored_domainstring | nullnullablerequired

host_refstring | nullnullablerequired

Id of the monitored host on the monitoring system

web_scenario_refstring | nullnullablerequired

Id of the check of the site (web scenario) on the monitoring system

statusstring | nullnullablerequired

Status of the site: healthy, problem (a recent check got an HTTP status outside 2xx) or frequent_problem

email_notificationstring | nullnullablerequired

Email address for the notices of the monitoring (site down or back up, SSL expiry); without it no email notice is sent

sms_notificationstring | nullnullablerequired

Italian mobile number for the SMS notices, without the international prefix; without it no SMS is sent

ipsstring | nullnullablerequired

IP address the monitored domain resolves to

ip_ispstring | nullnullablerequired

Internet service provider of the IP address

ip_locationstring | nullnullablerequired

Country of the IP address, as ISO 3166-1 alpha-2 code (for example IT)

last_http_responseinteger | nullnullablerequired

HTTP status code of the last check, for example 200

last_down_datedate-timenullablerequired

Last time a check found the site down (HTTP status outside 2xx)

send_ssl_notifyboolean | nullnullablerequired

Whether the notices of the expiry of the SSL certificate of the site are sent

activeboolean | nullnullablerequired

Whether the monitoring is active

metarequired

Always null: only the paginated lists have a meta

Constant value: null

WebMonitoringResponse

{
  "error": 0,
  "message": "string",
  "data": {
    "web_monitoring_id": 0,
    "purchase_id": 0,
    "service_name": "string",
    "purchase_name": "string",
    "purchase_status_code": "string",
    "monitored_domain": "string",
    "host_ref": "string",
    "web_scenario_ref": "string",
    "status": "string",
    "email_notification": "string",
    "sms_notification": "string",
    "ips": "string",
    "ip_isp": "string",
    "ip_location": "string",
    "last_http_response": 0,
    "last_down_date": "2024-07-29T15:51:28.071Z",
    "send_ssl_notify": true,
    "active": true
  }
}