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 `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

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

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

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

ENTITY_ID

EntityIdAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

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

HOST_NAME

HostNameAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

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

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

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

HOST_GROUP_NAME

HostGroupNameAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

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

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

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

MANAGEMENT_ZONE

ManagementZoneAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

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

NAME

NameAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

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

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

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

PROCESS_GROUP_ID

ProcessGroupIdAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

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

PROCESS_GROUP_NAME

ProcessGroupNameAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

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

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

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

TAG

TagFilterAlertingScope

ParametersJSON model

The `MetricEventAlertingScope` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY_ID` -> EntityIdAlertingScope `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope `TAG` -> TagFilterAlertingScope `NAME` -> NameAlertingScope `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope `HOST_GROUP_NAME` -> HostGroupNameAlertingScope `HOST_NAME` -> HostNameAlertingScope `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope The element can hold these values `CUSTOM_DEVICE_GROUP_NAME` `ENTITY_ID` `HOST_GROUP_NAME` `HOST_NAME` `MANAGEMENT_ZONE` `NAME` `PROCESS_GROUP_ID` `PROCESS_GROUP_NAME` `TAG`	required

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY_ID -> EntityIdAlertingScope
MANAGEMENT_ZONE -> ManagementZoneAlertingScope
TAG -> TagFilterAlertingScope
NAME -> NameAlertingScope
CUSTOM_DEVICE_GROUP_NAME -> CustomDeviceGroupNameAlertingScope
HOST_GROUP_NAME -> HostGroupNameAlertingScope
HOST_NAME -> HostNameAlertingScope
PROCESS_GROUP_ID -> ProcessGroupIdAlertingScope
PROCESS_GROUP_NAME -> ProcessGroupNameAlertingScope

The element can hold these values

CUSTOM_DEVICE_GROUP_NAME
ENTITY_ID
HOST_GROUP_NAME
HOST_NAME
MANAGEMENT_ZONE
NAME
PROCESS_GROUP_ID
PROCESS_GROUP_NAME
TAG

required

The `TagFilter` object

A tag-based filter of monitored entities.

Element Type Description Required

context

string

Element	Type	Description	Required
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`	required
key	string	The key of the tag. Custom tags have the tag value here.	required
value	string	The value of the tag. Not applicable to custom tags.	optional

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

required

key

string

The key of the tag.

Custom tags have the tag value here.

required

value

string

The value of the tag.

Not applicable to custom tags.

optional

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 `MetricEventDimensions` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY` -> MetricEventEntityDimensions `STRING` -> MetricEventStringDimensions The element can hold these values `ENTITY` `STRING`	required
key	string	The dimensions key on the metric.	optional

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY -> MetricEventEntityDimensions
STRING -> MetricEventStringDimensions

The element can hold these values

ENTITY
STRING

required

key

string

The dimensions key on the metric.

optional

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

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

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

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

STRING

MetricEventStringDimensions

ParametersJSON model

The `MetricEventDimensions` 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 Required

filterType

string

Element	Type	Description	Required
filterType	string	Defines the actual set of fields depending on the value. See one of the following objects: `ENTITY` -> MetricEventEntityDimensions `STRING` -> MetricEventStringDimensions The element can hold these values `ENTITY` `STRING`	required
key	string	The dimensions key on the metric.	optional

Defines the actual set of fields depending on the value. See one of the following objects:

ENTITY -> MetricEventEntityDimensions
STRING -> MetricEventStringDimensions

The element can hold these values

ENTITY
STRING

required

key

string

The dimensions key on the metric.

optional

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

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

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

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 `MetricEventMonitoringStrategy` 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 Required

type

string

Element	Type	Description	Required
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `STATIC_THRESHOLD` -> MetricEventStaticThresholdMonitoringStrategy `AUTO_ADAPTIVE_BASELINE` -> MetricEventAutoAdaptiveBaselineMonitoringStrategy The element can hold these values `AUTO_ADAPTIVE_BASELINE` `STATIC_THRESHOLD`	required

Defines the actual set of fields depending on the value. See one of the following objects:

STATIC_THRESHOLD -> MetricEventStaticThresholdMonitoringStrategy
AUTO_ADAPTIVE_BASELINE -> MetricEventAutoAdaptiveBaselineMonitoringStrategy

The element can hold these values

AUTO_ADAPTIVE_BASELINE
STATIC_THRESHOLD

required

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

STATIC_THRESHOLD

MetricEventStaticThresholdMonitoringStrategy

ParametersJSON model

The `MetricEventMonitoringStrategy` 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 Required

type

string

Element	Type	Description	Required
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `STATIC_THRESHOLD` -> MetricEventStaticThresholdMonitoringStrategy `AUTO_ADAPTIVE_BASELINE` -> MetricEventAutoAdaptiveBaselineMonitoringStrategy The element can hold these values `AUTO_ADAPTIVE_BASELINE` `STATIC_THRESHOLD`	required

Defines the actual set of fields depending on the value. See one of the following objects:

STATIC_THRESHOLD -> MetricEventStaticThresholdMonitoringStrategy
AUTO_ADAPTIVE_BASELINE -> MetricEventAutoAdaptiveBaselineMonitoringStrategy

The element can hold these values

AUTO_ADAPTIVE_BASELINE
STATIC_THRESHOLD

required

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 MetricEventAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

ENTITY_ID

The MetricEventAlertingScope object

HOST_NAME

The MetricEventAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

HOST_GROUP_NAME

The MetricEventAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

MANAGEMENT_ZONE

The MetricEventAlertingScope object

NAME

The MetricEventAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

PROCESS_GROUP_ID

The MetricEventAlertingScope object

PROCESS_GROUP_NAME

The MetricEventAlertingScope object

The MetricEventTextFilterMetricEventTextFilterOperatorDto object

TAG

The MetricEventAlertingScope object

The TagFilter object

Variations of the MetricEventDimensions object

ENTITY

The MetricEventDimensions object

The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object

STRING

The MetricEventDimensions object

The MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object

Variations of the MetricEventMonitoringStrategy object

AUTO_ADAPTIVE_BASELINE

The MetricEventMonitoringStrategy object

STATIC_THRESHOLD

The MetricEventMonitoringStrategy object

Variations of the `MetricEventAlertingScope` object

The `MetricEventAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `MetricEventAlertingScope` object

The `MetricEventAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `MetricEventAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `MetricEventAlertingScope` object

The `MetricEventAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `MetricEventAlertingScope` object

The `MetricEventAlertingScope` object

The `MetricEventTextFilterMetricEventTextFilterOperatorDto` object

The `MetricEventAlertingScope` object

The `TagFilter` object

Variations of the `MetricEventDimensions` object

The `MetricEventDimensions` object

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

The `MetricEventDimensions` object

The `MetricEventTextFilterMetricEventDimensionsFilterOperatorDto` object

Variations of the `MetricEventMonitoringStrategy` object

The `MetricEventMonitoringStrategy` object

The `MetricEventMonitoringStrategy` object