Get a monitor template

GET /monitors/templates/{templateId}

Get a monitor template

cURL

curl --request GET \
  --url https://api.eu.bronto.io/monitors/templates/{templateId} \
  --header 'X-BRONTO-API-KEY: <api-key>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "High Error Rate",
  "comparison_operator": "ABOVE",
  "threshold": "1000",
  "window": "'Last 20 minutes', 'Last 2 hours', 'Last 1 days'",
  "monitor_type": "PATTERN",
  "metadata": {
    "created_at": 123,
    "created_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "modified_at": 123,
    "modified_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "deleted_at": 123,
    "deleted_by": {
      "type": "API_KEY_ID",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "last_heartbeat_at": 123
  },
  "description": "Average response time is over 1 seconds in the last 20 minutes",
  "warning_threshold": "900",
  "actions": "<string>",
  "notify_once": "false",
  "no_data_status": "OK",
  "group_retention": 600000,
  "aux": {},
  "compare_to": "2 hours ago",
  "change_type": "DIFFERENCE",
  "evaluation_window": "'24 hours', '7 days'",
  "anomaly_algorithm": "MEDIAN_MAD",
  "metric_id": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "arguments": {}
  },
  "parameters": {}
}

Authorizations

ApiKeyAuthBearerAuth

X-BRONTO-API-KEY · string · header · required

Path Parameters

templateId · string<uuid> · required

The ID of the monitor template to retrieve

Response

200

application/json

Monitor template retrieved successfully

id · string<uuid> · required

The unique identifier for the monitor

name · string · required

The name of the monitor

Required string length: 1 - 255

Example:

"High Error Rate"

comparison_operator · enum<string> · required

the comparison operator of the monitor (ABOVE, ABOVE_OR_EQUAL, BELOW, BELOW_OR_EQUAL, EQUAL, NOT_EQUAL, OUTSIDE). OUTSIDE is two-sided and is only allowed for ANOMALY_DETECTION monitors, which are the only type whose compared value is a signed deviation from a baseline.

Available options: BELOW, BELOW_OR_EQUAL, ABOVE, ABOVE_OR_EQUAL, EQUAL, NOT_EQUAL, OUTSIDE

Example:

"ABOVE"

threshold · string · required

the threshold the monitor compares against. For PATTERN, USAGE and CHANGE_DETECTION monitors this is a metric value. For ANOMALY_DETECTION monitors it is instead a count of baseline spread units (scaled median absolute deviations, comparable to standard deviations), so it must be greater than 0; a threshold of 3 means "more than 3 spread units away from the baseline centre".

Example:

"1000"

window · string · required

The time window to evaluate the monitor; minimum five minutes, maximum one day

Example:

"'Last 20 minutes', 'Last 2 hours', 'Last 1 days'"

monitor_type · enum<string> · default: PATTERN · required

What the monitor compares its metric against. PATTERN and USAGE compare it to a fixed threshold, CHANGE_DETECTION to the same metric at an earlier time (see compare_to and change_type), and ANOMALY_DETECTION to a trailing baseline of the same series (see evaluation_window and anomaly_algorithm).

Available options: PATTERN, USAGE, CHANGE_DETECTION, ANOMALY_DETECTION

Example:

"PATTERN"

metadata · object · required

Common metadata attached to all persisted resources.

Show child attributes

description · string

Extra contextual information to add to the monitor

Maximum string length: 4000

Example:

"Average response time is over 1 seconds in the last 20 minutes"

warning_threshold · string

the warning threshold value, in the same units as threshold. For ANOMALY_DETECTION monitors it must be greater than 0 and less than threshold whatever the comparison operator, because the comparison is on the magnitude of the deviation.

Example:

"900"

actions · string

The list of actions (notifications) to take when the monitor fires or resolves

notify_once · string

Notify only the groups changing the global monitor status, i.e. notifications are sent only for the first group entering ALERT status or for the last group resolving

Example:

"false"

no_data_status · enum<string>

Specify the status to use if a group has no data (no events matched in a time window)

Available options: OK, NO_DATA, ALERT, WARN

Example:

"OK"

group_retention · integer<int64>

Remove groups with no data after the provided time in milliseconds

Required range: 0 <= x <= 604800000

Example:

600000

aux · object

Additional monitor configuration

compare_to · string

For change detection monitors only. How far back in time the comparison query should be run. Minimum "5 mins ago", maximum "1 month".

Example:

"2 hours ago"

change_type · enum<string>

For change detection monitors only. Specifies how the change values are calculated, as described in the Bronto documentation.

Available options: DIFFERENCE, PERCENTAGE

evaluation_window · string

For anomaly detection monitors only, where it is required. The trailing period used to build the baseline the candidate window is compared against, expressed as " ". It must cover at least 10 and at most 1000 monitor windows and be at most 30 days: fewer than 10 windows leaves the baseline permanently degenerate, so the monitor reports healthy and never fires.

Example:

"'24 hours', '7 days'"

anomaly_algorithm · enum<string> · default: MEDIAN_MAD

For anomaly detection monitors only. How the baseline centre and spread are estimated. MEDIAN_MAD uses the median as the centre and the median absolute deviation, scaled by 1.4826 so it reads like a standard deviation, as the spread.

Available options: MEDIAN_MAD

Example:

"MEDIAN_MAD"

metric_id · object

Show child attributes

parameters · object

Map of parameter names to their definitions. Each key represents the parameter name used within the template.

Show child attributes