Metric events anomaly detection API - JSON models

Some JSON models of the Metric events anomaly detection API vary, depending on the filterType of some objects. Here you can find JSON models for each variation.

Variations of the `MetricEventAlertingScope` object

The MetricEventAlertingScope object is the base for alerting scopes of metric events. The actual set of fields depends on the filterType of the scope.

CUSTOM_DEVICE_GROUP_NAME

CustomDeviceGroupNameAlertingScope

ParametersJSON model

The `CustomDeviceGroupNameAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventTextFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `CONTAINS_CASE_INSENSITIVE` `CONTAINS_CASE_SENSITIVE` `EQUALS`

json
{
  "filterType": "CUSTOM_DEVICE_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

ENTITY_ID

EntityIdAlertingScope

ParametersJSON model

The `EntityIdAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
entityId	string	The monitored entities id to match on.

json
{
  "filterType": "ENTITY_ID",
  "entityId": "HOST-B7A6F9EE9F366CB5"
}

HOST_NAME

HostNameAlertingScope

ParametersJSON model

The `HostNameAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventTextFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `CONTAINS_CASE_INSENSITIVE` `CONTAINS_CASE_SENSITIVE` `EQUALS`

json
{
  "filterType": "HOST_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

HOST_GROUP_NAME

HostGroupNameAlertingScope

ParametersJSON model

The `HostGroupNameAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventTextFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `CONTAINS_CASE_INSENSITIVE` `CONTAINS_CASE_SENSITIVE` `EQUALS`

json
{
  "filterType": "HOST_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

MANAGEMENT_ZONE

ManagementZoneAlertingScope

ParametersJSON model

The `ManagementZoneAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
mzId	string	The management zone id to match on.

json
{
  "filterType": "MANAGEMENT_ZONE",
  "mzId": "6958644387494623526"
}

NAME

NameAlertingScope

ParametersJSON model

The `NameAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventTextFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `CONTAINS_CASE_INSENSITIVE` `CONTAINS_CASE_SENSITIVE` `EQUALS`

json
{
  "filterType": "NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

PROCESS_GROUP_ID

ProcessGroupIdAlertingScope

ParametersJSON model

The `ProcessGroupIdAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
processGroupId	string	The process groups id to match on.

json
{
  "filterType": "PROCESS_GROUP_ID",
  "processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"
}

PROCESS_GROUP_NAME

ProcessGroupNameAlertingScope

ParametersJSON model

The `ProcessGroupNameAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventTextFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `CONTAINS_CASE_INSENSITIVE` `CONTAINS_CASE_SENSITIVE` `EQUALS`

json
{
  "filterType": "PROCESS_GROUP_NAME",
  "nameFilter": {
    "value": "entity name",
    "operator": "CONTAINS_CASE_INSENSITIVE"
  }
}

TAG

TagFilterAlertingScope

ParametersJSON model

The `TagFilterAlertingScope` object

A single filter for the alerting scope.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
tagFilter	TagFilter	A tag-based filter of monitored entities.

The `TagFilter` object

A tag-based filter of monitored entities.

Element Type Description

context

string

Element	Type	Description
context	string	The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. The element can hold these values `AWS` `AWS_GENERIC` `AZURE` `CLOUD_FOUNDRY` `CONTEXTLESS` `ENVIRONMENT` `GOOGLE_CLOUD` `KUBERNETES`
key	string	The key of the tag. Custom tags have the tag value here.
value	string	The value of the tag. Not applicable to custom tags.

The origin of the tag, such as AWS or Cloud Foundry.

Custom tags use the CONTEXTLESS value.

The element can hold these values

AWS
AWS_GENERIC
AZURE
CLOUD_FOUNDRY
CONTEXTLESS
ENVIRONMENT
GOOGLE_CLOUD
KUBERNETES

key

string

The key of the tag.

Custom tags have the tag value here.

value

string

The value of the tag.

Not applicable to custom tags.

json
{
  "filterType": "TAG",
  "tagFilter": {
    "context": "CONTEXTLESS",
    "key": "Infrastructure",
    "value": "Linux"
  }
}

Variations of the `MetricEventDimensions` object

The MetricEventDimensions object is the base for metric dimensions. The actual set of fields depends on the filterType of the dimension.

ENTITY

MetricEventEntityDimensions

ParametersJSON model

The `MetricEventEntityDimensions` object

A single filter for the metrics dimensions.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
nameFilter	MetricEventTextFilterMetricEventDimensionsFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `EQUALS`

json
{
  "filterType": "ENTITY",
  "name": "dimension",
  "index": 1,
  "nameFilter": {
    "value": "entity name",
    "operator": "EQUALS"
  }
}

STRING

MetricEventStringDimensions

ParametersJSON model

The `MetricEventStringDimensions` object

A single filter for the metrics dimensions.

The actual set of fields depends on type of the filter. Find the list of actual objects in the description of the filterType field or see Metric events anomaly detection API - JSON models.

Element	Type	Description
textFilter	MetricEventTextFilterMetricEventDimensionsFilterOperatorDto	A filter for a string value based on the given operator.

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

A filter for a string value based on the given operator.

Element	Type	Description
value	string	The value to match on.
operator	string	The operator to match on. The element can hold these values `EQUALS`

json
{
  "filterType": "STRING",
  "name": "dimension",
  "index": 1,
  "nameFilter": {
    "value": "entity name",
    "operator": "EQUALS"
  }
}

Variations of the `MetricEventMonitoringStrategy` object

The MetricEventMonitoringStrategy object is the base for monitoring strategy of a metric event. The actual set of fields depends on the type of the strategy.

AUTO_ADAPTIVE_BASELINE

MetricEventAutoAdaptiveBaselineMonitoringStrategy

ParametersJSON model

The `MetricEventAutoAdaptiveBaselineMonitoringStrategy` object

A monitoring strategy for a metric event config.

This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.

Element	Type	Description
samples	integer	The number of one-minute samples that form the sliding evaluation window.
violatingSamples	integer	The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.
dealertingSamples	integer	The number of one-minute samples within the evaluation window that must go back to normal to close the event.
alertCondition	string	The condition for the threshold value check: above or below. The element can hold these values `ABOVE` `BELOW`
alertingOnMissingData	boolean	If true, also one-minute samples without data are counted as violating samples.
numberOfSignalFluctuations	number	Defines the factor of how many signal fluctuations are valid. Values above the baseline plus the signal fluctuation times the number of tolerated signal fluctuations are alerted.

json
{
  "type": "AUTO_ADAPTIVE_BASELINE",
  "samples": 5,
  "violatingSamples": 3,
  "dealertingSamples": 5,
  "alertCondition": "ABOVE",
  "alertingOnMissingData": false,
  "numberOfSignalFluctuations": 1.0
}

STATIC_THRESHOLD

MetricEventStaticThresholdMonitoringStrategy

ParametersJSON model

The `MetricEventStaticThresholdMonitoringStrategy` object

A monitoring strategy for a metric event config.

This is the base version of the monitoring strategy, depending on the type, the actual JSON may contain additional fields.

Element	Type	Description
samples	integer	The number of one-minute samples that form the sliding evaluation window.
violatingSamples	integer	The number of one-minute samples within the evaluation window that must violate the threshold to trigger an event.
dealertingSamples	integer	The number of one-minute samples within the evaluation window that must go back to normal to close the event.
alertCondition	string	The condition for the threshold value check: above or below. The element can hold these values `ABOVE` `BELOW`
alertingOnMissingData	boolean	If true, also one-minute samples without data are counted as violating samples.
threshold	number	The value of the static threshold based on the specified unit.
unit	string	The unit of the threshold, matching the metric definition. The element can hold these values `BILLION` `BIT` `BIT_PER_HOUR` `BIT_PER_MINUTE` `BIT_PER_SECOND` `BYTE` `BYTE_PER_HOUR` `BYTE_PER_MINUTE` `BYTE_PER_SECOND` `CORES` `COUNT` `DAY` `DECIBEL_MILLI_WATT` `GIBI_BYTE` `GIGA` `GIGA_BYTE` `HOUR` `KIBI_BYTE` `KIBI_BYTE_PER_HOUR` `KIBI_BYTE_PER_MINUTE` `KIBI_BYTE_PER_SECOND` `KILO` `KILO_BYTE` `KILO_BYTE_PER_HOUR` `KILO_BYTE_PER_MINUTE` `KILO_BYTE_PER_SECOND` `KILO_METRE_PER_HOUR` `MEBI_BYTE` `MEBI_BYTE_PER_HOUR` `MEBI_BYTE_PER_MINUTE` `MEBI_BYTE_PER_SECOND` `MEGA` `MEGA_BYTE` `MEGA_BYTE_PER_HOUR` `MEGA_BYTE_PER_MINUTE` `MEGA_BYTE_PER_SECOND` `METRE_PER_HOUR` `METRE_PER_SECOND` `MICRO_SECOND` `MILLION` `MILLI_CORES` `MILLI_SECOND` `MILLI_SECOND_PER_MINUTE` `MINUTE` `MONTH` `MSU` `NANO_SECOND` `NANO_SECOND_PER_MINUTE` `NOT_APPLICABLE` `PERCENT` `PER_HOUR` `PER_MINUTE` `PER_SECOND` `PIXEL` `PROMILLE` `RATIO` `SECOND` `STATE` `TRILLION` `UNSPECIFIED` `WEEK` `YEAR`

json
{
  "type": "STATIC_THRESHOLD",
  "samples": 3,
  "violatingSamples": 1,
  "dealertingSamples": 3,
  "alertCondition": "BELOW",
  "alertingOnMissingData": false,
  "threshold": 99,
  "unit": "COUNT"
    }

Metric events anomaly detection API - JSON models

Variations of the MetricEventAlertingScope object

CUSTOM_DEVICE_GROUP_NAME

The CustomDeviceGroupNameAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

ENTITY_ID

The EntityIdAlertingScope object

HOST_NAME

The HostNameAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

HOST_GROUP_NAME

The HostGroupNameAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

MANAGEMENT_ZONE

The ManagementZoneAlertingScope object

NAME

The NameAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

PROCESS_GROUP_ID

The ProcessGroupIdAlertingScope object

PROCESS_GROUP_NAME

The ProcessGroupNameAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

TAG

The TagFilterAlertingScope object

The TagFilter object

Variations of the MetricEventDimensions object

ENTITY

The MetricEventEntityDimensions object

The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object

STRING

The MetricEventStringDimensions object

The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object

Variations of the MetricEventMonitoringStrategy object

AUTO_ADAPTIVE_BASELINE

The MetricEventAutoAdaptiveBaselineMonitoringStrategy object

STATIC_THRESHOLD

The MetricEventStaticThresholdMonitoringStrategy object

Variations of the `MetricEventAlertingScope` object

The `CustomDeviceGroupNameAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `EntityIdAlertingScope` object

The `HostNameAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `HostGroupNameAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `ManagementZoneAlertingScope` object

The `NameAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `ProcessGroupIdAlertingScope` object

The `ProcessGroupNameAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `TagFilterAlertingScope` object

The `TagFilter` object

Variations of the `MetricEventDimensions` object

The `MetricEventEntityDimensions` object

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

The `MetricEventStringDimensions` object

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

Variations of the `MetricEventMonitoringStrategy` object

The `MetricEventAutoAdaptiveBaselineMonitoringStrategy` object

The `MetricEventStaticThresholdMonitoringStrategy` object