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
The CustomDeviceGroupNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter | MetricEventTextFilterMetricEventTextFilterOperatorDto | 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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventTextFilterOperatorDto object:
- CONTAINS_CASE_INSENSITIVE
- CONTAINS_CASE_SENSITIVE
- EQUALS
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "CUSTOM_DEVICE_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
ENTITY_ID
The EntityIdAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| entityId | string |
The monitored entities id to match on. |
required |
Possible values
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "ENTITY_ID",
"entityId": "HOST-B7A6F9EE9F366CB5"
}
HOST_NAME
The HostNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter | MetricEventTextFilterMetricEventTextFilterOperatorDto | 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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventTextFilterOperatorDto object:
- CONTAINS_CASE_INSENSITIVE
- CONTAINS_CASE_SENSITIVE
- EQUALS
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "HOST_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
HOST_GROUP_NAME
The HostGroupNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter | MetricEventTextFilterMetricEventTextFilterOperatorDto | 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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventTextFilterOperatorDto object:
- CONTAINS_CASE_INSENSITIVE
- CONTAINS_CASE_SENSITIVE
- EQUALS
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "HOST_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
MANAGEMENT_ZONE
The ManagementZoneAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| mzId | string |
The management zone id to match on. |
optional |
Possible values
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "MANAGEMENT_ZONE",
"mzId": "6958644387494623526"
}
NAME
The NameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter | MetricEventTextFilterMetricEventTextFilterOperatorDto | 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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventTextFilterOperatorDto object:
- CONTAINS_CASE_INSENSITIVE
- CONTAINS_CASE_SENSITIVE
- EQUALS
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
PROCESS_GROUP_ID
The ProcessGroupIdAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| processGroupId | string |
The process groups id to match on. |
required |
Possible values
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "PROCESS_GROUP_ID",
"processGroupId": "PROCESS_GROUP-B34081EFF9E5F516"
}
PROCESS_GROUP_NAME
The ProcessGroupNameAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| nameFilter | MetricEventTextFilterMetricEventTextFilterOperatorDto | 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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventTextFilterOperatorDto object:
- CONTAINS_CASE_INSENSITIVE
- CONTAINS_CASE_SENSITIVE
- EQUALS
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"filterType": "PROCESS_GROUP_NAME",
"nameFilter": {
"value": "entity name",
"operator": "CONTAINS_CASE_INSENSITIVE"
}
}
TAG
The TagFilterAlertingScope object
A single filter for the alerting scope.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| tagFilter | TagFilter | required |
The TagFilter object
A tag-based filter of monitored entities.
| Element | Type | Description | Required |
|---|---|---|---|
| context | string |
The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the |
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 |
Possible values
Possible values for the context element in the TagFilter object:
- AWS
- AWS_GENERIC
- AZURE
- CLOUD_FOUNDRY
- CONTEXTLESS
- ENVIRONMENT
- GOOGLE_CLOUD
- KUBERNETES
Possible values for the filterType element:
- CUSTOM_DEVICE_GROUP_NAME
- ENTITY_ID
- HOST_GROUP_NAME
- HOST_NAME
- MANAGEMENT_ZONE
- NAME
- PROCESS_GROUP_ID
- PROCESS_GROUP_NAME
- TAG
{
"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
The MetricEventEntityDimensions object
A single filter for the metrics dimensions.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| name | string |
The dimensions name. Sending this has no effect while creating a configuration, as only the index of the dimension is used here -> dimension names might change, indexes not. |
optional |
| index | integer |
The dimensions index on the metric. |
required |
| nameFilter | MetricEventTextFilterMetricEventDimensionsFilterOperatorDto | required |
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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object:
- EQUALS
Possible values for the filterType element:
- ENTITY
- STRING
{
"filterType": "ENTITY",
"name": "dimension",
"index": 1,
"nameFilter": {
"value": "entity name",
"operator": "EQUALS"
}
}
STRING
The MetricEventStringDimensions object
A single filter for the metrics dimensions.
This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.
| Element | Type | Description | Required |
|---|---|---|---|
| filterType | string |
Defines the actual set of fields depending on the value. See one of the following objects:
|
required |
| name | string |
The dimensions name. Sending this has no effect while creating a configuration, as only the index of the dimension is used here -> dimension names might change, indexes not. |
optional |
| index | integer |
The dimensions index on the metric. |
required |
| textFilter | MetricEventTextFilterMetricEventDimensionsFilterOperatorDto | required |
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 operator element can hold these values. |
required |
Possible values
Possible values for the operator element in the MetricEventTextFilterMetricEventDimensionsFilterOperatorDto object:
- EQUALS
Possible values for the filterType element:
- ENTITY
- STRING
{
"filterType": "STRING",
"name": "dimension",
"index": 1,
"nameFilter": {
"value": "entity name",
"operator": "EQUALS"
}
}