API (JSON) Endpoint

Available Metrics

Possible metric types that can be tracked on a given resource.

Metric Type Data Type Description
AggregatedMetric
Object
Allows for aggregating existing metrics over a period of time. Useful for running sums or averages; also for extracting single data item from collection-based metrics
DerivedMetric
Double
Allows for deriving new metrics from existing ones. Useful for combining existing metrics together or for multiplying metrics by a factor
JsonPathItemArray
Object[]
Allows for extraction and tracking of collection of objects from returning JSON
JsonPathItemNumeric
Double
Allows for extraction and tracking of a numeric item from returning JSON
JsonPathItemString
String
Allows for extraction and tracking of a single string item from returning JSON
LinkedMetric
Object
Allows for tracking of metrics from other resources. Useful when it is important to evaluate metrics from different resources side-by-side
ResourceStatus
String
Tracks overall status of the resource. This is an important metric as it is used to drive Uptime reports. Possible values: Ready, Down, Unknown and in some cases Stopped
ResponseTime
Double
Measures time to connect to resource
UrlResponseCode
Int32
Tracks HTTP response code (as an integer value). Examples: OK = 200, Exception: 500, Unauthorized: 403, etc.
UrlResponseText
String
Tracks actual the text of actual response from the monitored URL. Useful for inspection of resulting HTML/XML/JSON. This is potentially a large-size metric - use sparingly
UrlSslExpirationInDays
Double
Tracks number of days before SSL certificate of the monitored URL expires

Available Commands

Possible commands that can be executed on a given resource. Ultimate subscription is required.

Command Type Description
WebRequest Runs custom WebRequest to specified URL
WebRequestJson Runs JSON WebRequest to specified URL (ContType is JSON)

Default Templates

CloudMonix provided default monitoring templates.

Pre-configured Metrics

Metric Name Metric Type Description
JsonPathItemArray JsonPathItemArray Tracks JSON array from response
JsonPathItemNumeric JsonPathItemNumeric Tracks JSON item numeric value from response
JsonPathItemString JsonPathItemString Tracks JSON item numeric value from response
ResponseCode UrlResponseCode Tracks HTTP response code
ResponseTime ResponseTime Response time in milliseconds
Status ResourceStatus Tracks the overall readiness status of the monitored resource. Possible values are: Ready, Down, Stopped and Unknown

Pre-configured Alerts

Alert Name Expression Severity Description
Resource Outage Status == "Down" Error Fires an alert if connection cannot be established within 3 minutes sustained
Slow Response ResponseTime > 15000 Warning Raises an alert if response time from the website is over 15 seconds, sustained for 5+ minutes