Email Digest API

This page provides Email Digest API methods you can use to report a summary of a specific event(s) to a recipient list configured on a health rule schedule. Email digests are triggered as a response to a health rule violation event.

Syntax validation of the JSON payload is done when creating the email digest.

Create a New Email Digest

Creates a new email digest with the specified JSON payload. See Property Details.

Resource URL

POST <controller_url>/controller/alerting/rest/v1
/applications/<application_id>/email-digests

Request/Response Format

JSON

Example

This example creates a new email digest. See Download Examples.

{
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

This example returns the created email digest object.

{
  "id": 0,
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

Retrieve a List of Email Digests for an Application

This API returns the email digest names, IDs, and enable flag details pertaining to the specified application. See Property Details.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests

Response Format

JSON

Example Response

This example returns a list of email digests pertaining to the specified application ID.

[
  {
    "id": 12,
    "name": "some email digest name",
    "enabled": true
  }
]

YML

Retrieve Details of an Email Digest

Retrieves the details of an email digest with a specified ID. See Property Details.

Ensure that you provide a valid email digest ID.

Resource URL

GET <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}

Response Format

JSON

Example Response

{
  "id": 0,
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

Update an Email Digest

Updates an existing email digest with a specified JSON payload. See Property Details.

This request requires a complete JSON payload as input. It is recommended that you retrieve the JSON payload using,

GET email-digests/{email-digest-id} and update the required fields. Then, send the modified payload as part of PUT request.

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}

Request/Response Format

JSON

Example

This example updates an action. See Download Examples.

{
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

This example returns the updated action.

{
  "id": 0,
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

Delete an Email Digest

Deletes an email digest with the specified ID. See Property Details.

Ensure that you provide a valid email digest ID.

Resource URL

DELETE <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}

Update one or more properties of an Email Digest

Updates the properties of an existing email digest with a specified JSON payload. See Property Details

Resource URL

PUT <controller_url>/controller/alerting/rest/v1/applications/<application_id>/email-digests/{email-digest-id}/configuration

Request/Response Format

JSON

Example

This example updates the properties of a specified email digest.

{
  "enabled": true,
  "emailDigestName": "test email digest",
  "frequency": 2
}

YML

This example returns the properties updated for a specified email digest.

{
  "id": 0,
  "name": "My new email digest",
  "enabled": true,
  "executeActionsInBatch": true,
  "frequency": 2,
  "actions": [
    {
      "actionName": "My action 1",
      "actionType": "SMS"
    }
  ],
  "events": {
    "healthRuleEvents": {
      "healthRuleEventTypes": [
        "HEALTH_RULE_CONTINUES_CRITICAL",
        "HEALTH_RULE_UPGRADED"
      ],
      "healthRuleScope": {
        "healthRuleScopeType": "ALL_HEALTH_RULES"
      }
    },
    "otherEvents": [
      "CLR_CRASH",
      "DEADLOCK"
    ],
    "anomalyEvents": [
      "ANOMALY_OPEN_WARNING",
      "ANOMALY_CLOSE_CRITICAL"
    ],
    "customEvents": [
      {
        "eventName": "string",
        "propertyMatchCriteria": "ANY",
        "keyValuePairArray": [
          {
            "key": "key1",
            "value": "value1"
          }
        ]
      }
    ]
  },
  "selectedEntities": {
    "selectedEntityType": "ANY_ENTITY"
  }
}

YML

Response Codes

Code	Description
200	Fetched successfully
201	Created successfully
204	Deleted successfully
400	Bad request
401	Unauthorized
403	Forbidden
404	Resource not found
409	Already exists

Property Details

Email Digest

Payload details of an email digest.

Property Name

Type

Description and Valid Values

id

integer

This is auto-generated by the system and returned in the response.

It is a readOnly value.

name^*

string

Minimum length: 1

Name of the email digest.

enabled

boolean

Default value: true

Sets the email digest to enabled/disabled state.

frequency

integer
minimum: 1
maximum: 168

The frequency in hours at which emails are sent as a response to an event.

actions^*

minItems: 1

Action

Describes the predefined, reusable, and automated response to an event to be taken when the event is triggered.

Property Name Type Description

actionName^*

string

Name of the action defined for an email digest.

actionType^*

string

ActionTypeEnum

Creates the following types of actions:

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

events^*

Events

Describes the events that trigger the email digest.

Property Name Description

healthRuleEvents

HealthRuleEvents

Describes the trigger event type(s) generated due to health rule issues.

Property Name Description

healthRuleEventTypes^*

HealthRuleEventTypes

Describes the event type related to health rule that triggers the email digest.

minItems: 1

HealthRuleEventTypeEnum

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

HealthRuleScope

Describes the scope of the health rule based on which, the events are triggered.

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

otherEvents

OtherEvents

Describes the trigger event type(s) generated due to other issues.

Property Name Description

OtherEventType

Lists the event type that triggers an action.

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT, SLOW, VERY_SLOW, STALL

ERROR

anomalyEvents

AnomalyEvents

Describes the trigger event type(s) generated due to anomaly detection.

minItems: 1

Property Name Description

AnomalyEventType

Lists the event type that triggers an action.

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

customEvents

The custom event type(s) you define.

Property Name Type Description

eventName^* string Custom event name.

propertyMatchCriteria

string

Enums

ANY

ALL

keyValuePairArray

string

KeyValuePair

key^*

value^*

selectedEntities

SelectedEntityType

Scope of entities considered for the email digest.

Entities corresponding to EUM applications are not supported.

Property Name Type Description

SelectedEntityType^*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

SelectedEntityType

Scope of entities considered for the email digest.

Property Name Type Description

SelectedEntityType^*

string

Enums

ANY_ENTITY

SPECIFIC_ENTITIES

SpecificEntities

Scope of specific entities considered for the email digest.

Property Name Type Description

selectedEntityType^*

string

Enum

SPECIFIC_ENTITIES

entities

minItems: 1

Entity

Property name Type Description

entityType^*

string

minItems: 1

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

PAGE

AJAX_REQUEST

SYNTHETIC_JOBS

IFRAME

VIRTUAL_PAGE

MOBILE_APPS

MOBILE_NETWORK_REQUESTS

Entity

Property name Type Description

entityType^*

string

minItems: 1

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

PAGE

AJAX_REQUEST

SYNTHETIC_JOBS

IFRAME

VIRTUAL_PAGE

MOBILE_APPS

MOBILE_NETWORK_REQUESTS

AnyEntity

Scope of entities considered for the email digest.

Property Name Type Description

SelectedEntityType^*

string

Enums

ANY_ENTITY

SelectedMobileApps

Property name Type Description

mobileAppsScope^*

string

Enums

ALL_MOBILE_APPS

SPECIFIC_MOBILE_APPS

MOBILE_APPS_MATCHING_PATTERN

AllMobileApps

Property name Type Description

mobileAppsScope^*

string

Enum

ALL_MOBILE_APPS

SpecificMobileApps

Property name Type Description

mobileAppsScope^*

string

Enum

SPECIFIC_MOBILE_APPS

mobileApps

string

minItems: 1

MobileAppsMatchingPattern

Property name Type Description

mobileAppsScope^*

string

Enum

MOBILE_APPS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

MobileNetworkRequests

Property name Type Description

entityType^*

string

minItems: 1

Enum

MOBILE_NETWORK_REQUESTS

selectedMobileNetworkRequests^*

string

MobileNetworkRequestsScope

Enums

ALL_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS

MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN

SelectedMobileNetworkRequests

Property name Type Description

mobileNetworkRequestsScope^*

string

MobileNetworkRequestsScope

Enums

ALL_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS

MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN

AllMobileNetworkRequests

The scope of mobile network requests is ALL_MOBILE_NETWORK_REQUESTS.

Property name Type Description

mobileNetworkRequestsScope^*

string

MobileNetworkRequestsScope

Enum

ALL_MOBILE_NETWORK_REQUESTS

SpecificMobileNetworkRequests

The scope of mobile network requests is SPECIFIC_MOBILE_NETWORK_REQUESTS.

Property name Type Description

mobileNetworkRequestsScope^*

string

MobileNetworkRequestsScope

Enum

SPECIFIC_MOBILE_NETWORK_REQUESTS

mobileNetworkRequests^*

string

minItems:1

SpecificMobileAppsNetworkRequests

The scope of mobile network requests is SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS.

Property name Type Description

mobileNetworkRequestsScope^*

string

MobileNetworkRequestsScope

Enum

SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS

mobileApps^*

string

minItems:1

MobileNetworkRequestsMatchingPattern

The scope of mobile network requests is MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN.

Property name Type Description

mobileNetworkRequestsScope^*

string

MobileNetworkRequestsScope

Enum

MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

Page

The scope of entities considered for the email digest is page for EUM applications.

Property name Type Description

entityType^*

string

minItems: 1

Enum

PAGE

selectedPages*

string

pageScope

Enums

ALL_PAGES

SPECIFIC_PAGES

PAGES_MATCHING_PATTERN

SelectedPages

The scope of entities considered for the email digest is selected pages for EUM applications.

Property name Type Description

pageScope^*

string

Enums

ALL_PAGES

SPECIFIC_PAGES

PAGES_MATCHING_PATTERN

AllPages

The scope of entities considered for the email digest is ALL_PAGES for EUM applications.

Property name Type Description

pageScope^*

string

Enum

ALL_PAGES

SpecificPages

The scope of entities considered for the email digest is SPECIFIC_PAGES for EUM applications.

Property name Type Description

pageScope^*

string

Enum

SPECIFIC_PAGES

pages^*

array of strings

minItems: 1

PagesMatchingPattern

The scope of entities considered for the email digest is SPECIFIC_PAGES for EUM applications.

Property name Type Description

pageScope^*

string

Enum

PAGES_MATCHING_PATTERN

pages^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

VirtualPage

Property name Type Description

entityType^*

string

minItems: 1

Enum

VIRTUAL_PAGE

selectedVirtualPages^*

string

SelectedVirtualPages

Enums

ALL_VIRTUAL_PAGES

SPECIFIC_VIRTUAL_PAGES

VIRTUAL_PAGES_MATCHING_PATTERN

SelectedVirtualPages

Property name Type Description

virtualPageScope^*

string

SelectedVirtualPages

Enums

ALL_VIRTUAL_PAGES

SPECIFIC_VIRTUAL_PAGES

VIRTUAL_PAGES_MATCHING_PATTERN

AllVirtualPages

Property name Type Description

virtualPageScope^*

string

SelectedVirtualPages

Enum

ALL_VIRTUAL_PAGES

SpecificVirtualPages

Property name Type Description

virtualPageScope^*

string

SelectedVirtualPages

Enum

SPECIFIC_VIRTUAL_PAGES

virtualPages

string

minItems: 1

VirtualPagesMatchingPattern

Property name Type Description

virtualPageScope^*

string

SelectedVirtualPages

Enum

VIRTUAL_PAGES_MATCHING_PATTERN

patternMatcher

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

SyntheticJob

Property name Type Description

entityType^*

string

minItems: 1

Enum

SYNTHETIC_JOBS

selectedSyntheticJobs^*

string

SelectedSyntheticJobs

Enums

ALL_SYNTHETIC_JOBS

SPECIFIC_SYNTHETIC_JOBS

SYNTHETIC_JOBS_MATCHING_PATTERN

SelectedSyntheticJobs

Property name Type Description

syntheticJobScope^*

string

Enums

ALL_SYNTHETIC_JOBS

SPECIFIC_SYNTHETIC_JOBS

SYNTHETIC_JOBS_MATCHING_PATTERN

AllSyntheticJobs

Property name Type Description

syntheticJobScope^*

string

Enum

ALL_SYNTHETIC_JOBS

SpecificSyntheticJobs

Property name Type Description

syntheticJobScope^*

string

Enum

SPECIFIC_SYNTHETIC_JOBS

syntheticJobs^*

string

minItems: 1

SyntheticJobsMatchingPattern

Property name Type Description

syntheticJobScope^*

string

Enum

SYNTHETIC_JOBS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

IFrame

Property name Type Description

entityType^*

string

minItems: 1

Enum

IFRAME

selectedIFrames^*

string

iFrameScope

Enums

ALL_IFRAMES

SPECIFIC_IFRAMES

IFRAMES_MATCHING_PATTERN

SelectedIFrames

Property name Type Description

iFrameScope^*

string

Enums

ALL_IFRAMES

SPECIFIC_IFRAMES

IFRAMES_MATCHING_PATTERN

AllIFrames

Property name Type Description

iFrameScope^*

string

Enum

ALL_IFRAMES

SpecificIFrames

Property name Type Description

iFrameScope^*

string

Enum

SPECIFIC_IFRAMES

iFrames^*

string

minItems: 1

IFramesMatchingPattern

Property name Type Description

iFrameScope^*

string

Enum

IFRAMES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

AjaxRequest

Property name Type Description

entityType^*

string

minItems: 1

Enum

AJAX_REQUEST

selectedAjaxRequests^*

string

AjaxRequestsScope

Enums

ALL_AJAX_REQUESTS

SPECIFIC_AJAX_REQUESTS

AJAX_REQUESTS_MATCHING_PATTERN

SelectedAjaxRequests

Property name Type Description

selectedAjaxRequests^*

string

Enums

ALL_AJAX_REQUESTS

SPECIFIC_AJAX_REQUESTS

AJAX_REQUESTS_MATCHING_PATTERN

AllAjaxRequests

Property name Type Description

selectedAjaxRequests^*

string

Enum

ALL_AJAX_REQUESTS

SpecificAjaxRequests

Property name Type Description

selectedAjaxRequests^*

string

Enum

SPECIFIC_AJAX_REQUESTS

ajaxRequests^*

array of strings

minItems: 1

AjaxRequestsMatchingPattern

Property name Type Description

ajaxRequestScope^*

string

Enum

AJAX_REQUESTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

BusinessTransaction

All entities of type BUSINESS_TRANSACTION are considered for email digest.

Property Name Type Description

entityType^*

string

Enum

BUSINESS_TRANSACTION

selectedBusinessTransactions^*

string

BusinessTransactionScope

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

SelectedBusinessTransactions

Property Name Description

businessTransactionScope^*

Enums

ALL_BUSINESS_TRANSACTIONS SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

AllBusinessTransactions

The scope of business transactions is set to all business transactions.

Property Name Description

businessTransactionScope^*

Enum

ALL_BUSINESS_TRANSACTIONS

SpecificBusinessTransactions

The scope of business transactions is set to select business transactions.

Property Name Type Description

businessTransactionScope^*

string

Enum

SPECIFIC_BUSINESS_TRANSACTIONS

businessTransactions^*

array of strings

minItems: 1

Name(s) of the business transactions.

BusinessTransactionsInSpecificTiers

The scope of business transactions is set to business transactions associated with a specific tier.

Property Name Type Description

businessTransactionScope^*

Enum

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

Name of the specified tier.

BusinessTransactionsMatchingPattern

The scope of business transactions is set to business transactions that match a specific pattern.

Property Name Description

businessTransactionScope^*

Enum

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Business transactions that match the specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

SelectedTierOrNodeEntities

Specific tiers or nodes are considered for the email digest.

Property Name Type Description

entityType^*

string

Enum

TIER_NODE

tierOrNode^*

string

minLength: 1

TierOrNode

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

TierOrNode

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

TierSelectedEntities

Property Name Type Description

tierOrNodeScope^*

string

Enums

TIER_SELECTED_ENTITIES

selectedTiers^*

SelectedTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

SelectedTiers

Property Name Type Description

selectedTierScope^*

string

Enums

ALL_TIERS

SPECIFIC_TIERS

AllTiers

Property Name Type Description

selectedTierScope^*

string

Enum

ALL_TIERS

SpecificTiers

Property Name Type Description

selectedTierScope^*

string

Enum

SPECIFIC_TIERS

tiers^*

string

minItems: 1

Name(s) of the specified tier(s).

NodeSelectedEntities

Property Name Type Description

tierOrNodeScope^*

string

Enum

NODE_SELECTED_ENTITIES

typeofNode^*

string

Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

selectedNodes^*

SelectedNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

SelectedNodes

Property Name Type Description

selectedNodeScope^*

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

AllNodes

Property Name Type Description

selectedNodeScope^*

string

Enum

ALL_NODES

SpecificNodes

Property Name Type Description

selectedNodeScope^*

string

Enum

SPECIFIC_NODES

nodes^*

string

minItems: 1

Name(s) of the specified node(s).

NodesOfSpecificTiers

Property Name Type Description

selectedNodeScope^*

string

Enum

NODES_OF_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

Name(s) of tier with the associated nodes.

NodesMatchingPattern

Property Name Type Description

selectedNodeScope^*

string

Enum

NODES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Nodes that match a specified pattern are included in the scope.

Property Name Type Description

matchTo^*

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

NodePropertyVariableMatcher

Property Name Type Description

selectedNodeScope^*

string

Enum

NODE_PROPERTY_VARIABLE_MATCHER

propVarPairs^*

minItems: 1

propVarPairs

Property Name Type Description

propertyType^*

string

NodePropertyTypeEnum

META

ENV

JVM

name^*

string

minLength: 1

value^*

string

minLength: 1

Errors

Specific errors are considered for email digest.

Property Name Type Description

entityType^*

string

Enum

ERRORS

selectedErrors^*

SelectedErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

SelectedErrors

Property Name Type Description

errorScope^*

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

AllErrors

Property Name Type Description

errorScope^*

string

Enum

ALL_ERRORS

SpecificErrors

Property Name Type Description

errorScope^*

string

Enum

SPECIFIC_ERRORS

errors^*

string

minItems: 1

Example: NullPointerException

ErrorsOfSpecificTiers

Property Name Type Description

errorScope^*

string

Enum

ERRORS_OF_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

ErrorsMatchingPattern

Property Name Type Description

errorScope^*

string

Enum

ERRORS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

ServiceEndpoints

Specific service endpoints are considered for email digest.

Property Name Type Description

entityType^*

string

Enum

SERVICE_ENDPOINTS

selectedServiceEndpoints^*

SelectedServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

SelectedServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

AllServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enums

ALL_SERVICE_ENDPOINTS

SpecificServiceEndpoints

Property Name Type Description

serviceEndpointScope^*

string

Enum

SPECIFIC_SERVICE_ENDPOINTS

serviceEndpoints^*

string

minItems: 1

ServiceEndpointsInSpecificTiers

Property Name Type Description

serviceEndpointScope^*

string

Enum

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

ServiceEndpointsMatchingPattern

Property Name Type Description

serviceEndpointScope^*

string

Enum

SERVICE_ENDPOINTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

InformationPoints

Specific information points are considered for email digest.

Property Name Type Description

entityType^*

string

Enum

INFORMATION_POINTS

selectedInformationPoints^*

SelectedInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

SelectedInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

AllInformationPoints

Property Name Type Description

informationPointScope^*

string

Enums

ALL_INFORMATION_POINTS

SpecificInformationPoints

Property Name Type Description

informationPointScope^*

string

Enum

SPECIFIC_INFORMATION_POINTS

informationPoints^*

string

minItems: 1

InformationPointsMatchingPattern

Property Name Type Description

informationPointScope^*

string

Enum

INFORMATION_POINTS_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

DatabasesInApplication

Specific databases associated with the application are considered for email digest.

Property Name Type Description

entityType^*

string

Enums

DATABASES_IN_APPLICATION

selectedApplicationDatabases^*

SelectedApplicationDatabases

Property Name Type Description

applicationDatabaseScope

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

SelectedApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enums

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

AllApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enum

ALL_APPLICATION_DATABASES

SpecificApplicationDatabases

Property Name Type Description

applicationDatabaseScope^*

string

Enum

SPECIFIC_APPLICATION_DATABASES

applicationDatabases^*

string

minItems: 1

ApplicationDatabasesMatchingPattern

Property Name Type Description

applicationDatabaseScope^*

string

Enum

APPLICATION_DATABASES_MATCHING_PATTERN

patternMatcher^*

EntityMatchingPattern

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

ServersInApplication

Specific servers associated with the application are considered for the email digest.

Property Name Type Description

entityType^*

string

Enum

SERVERS_IN_APPLICATION

selectedServers^*

string

ApplicationSelectedServers

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

ApplicationSelectedServers

Property Name Type Description

serversScope^*

string

Enums

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

AllServersInApplication

Property Name Type Description

serversScope^*

string

Enum

ALL_SERVERS_IN_APPLICATION

SpecificServersInApplication

Property Name Type Description

serversScope^*

string

Enum

SPECIFIC_SERVERS_IN_APPLICATION

specificServers^*

string

minLength: 1

minItems: 1

AllServersInSpecificTiers

Property Name Type Description

serversScope^*

string

Enum

ALL_SERVERS_IN_SPECIFIC_TIERS

specificTiers^*

string

minItems: 1

Events

Different types of events considered for an email digest.

Property Name Type Description

healthRuleEvents

HealthRuleEvent

Events associated with health rules that trigger the email digest.

Property Name Type Description

healthRuleEventTypes^*

string

minItems: 1

HealthRuleEventType

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

string

Events associated with specific health rules or all health rules that trigger the email digest.

HealthRuleScopeType

Property Name Type Description

healthRuleScopeType

string

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

otherEvents

string

OtherEventType

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT

SLOW

VERY_SLOW

STALL

ERROR

anomalyEvents

minItems: 1

Events triggered due to anomaly detection.

AnomalyEventType

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

customEvents

Custom-defined events that trigger the email digest.

CustomEvent

Property Name Type Description

eventName^* string

PropertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

keyValuePairArray

KeyValuePair

Property Name	Type
Key^*	string
Value^*	string

CustomEvent

Details of custom-defined event considered for an email digest.

Property Name Type Description

eventName^* string

PropertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

keyValuePairArray

KeyValuePair

Property Name	Type
`Key^*`	string
`Value^*`	string

HealthRuleEvent

Events associated with health rules considered for an email digest.

Property Name Type Description

healthRuleEventTypes^*

string

minItems: 1

HealthRuleEventType

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

healthRuleScope^*

string

Events associated with specific health rules or all health rules that trigger the email digest.

healthRuleScopeType

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

HealthRuleScope

Events associated with specific health rules or all health rules considered for an email digest.

Property Name Type Description

healthRuleScopeType^*

string

Enums

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

AllHealthRules

Events associated with all health rules within an application considered for an email digest.

Property Name Type Description

healthRuleScopeType^*

string

Enum

ALL_HEALTH_RULES

SpecificHealthRules

Events associated with specific health rules within an application considered for an email digest.

Property Name Type Description

healthRuleScopeType^*

string

Enum

SPECIFIC_HEALTH_RULES

healthRules^*

string

minItems: 1

HealthRuleEventTypes

Property Name Type Description

healthRuleEventTypes^*

string

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

OtherEvents

Property Name Type Description

otherEvents

string

OtherEventType

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT

SLOW

VERY_SLOW

STALL

ERROR

AnomalyEvents

Events generated due to anomaly detection considered for an email digest.

Property Name Type Description

anomalyEvents

string

minItems: 1

AnomalyEventType

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

Action

A list of actions that are taken in response to an event.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

SimpleActionType

A simple action that is taken when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

EmailActionType

An email is sent when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

notes string

ActionOnSpecifiedEntities

A simple action that is taken for specific entities when the policy is triggered.

Property Name Type Description

actionName^* string

actionType^*

string

ActionType

Enums

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

specifiedEntityActionDetails^*

string

SpecifiedEntityActionDetails

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

SpecifiedEntityActionDetails

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enums

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

ActionOnPercentageEntities

The scope of entities on which the action is performed is set to percentage.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enum

PERCENTAGE

value^* integer

ActionOnAbsoluteEntities

The scope of entities on which the action is performed is set to absolute.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enum

ABSOLUTE

value^* integer

ActionOnSpecificNodes

A list of nodes on which the action is performed.

Property Name Type Description

specifiedEntityActionScope

string

SpecifiedEntityActionScope

Enum

SPECIFIC_NODES

nodes^*

string

minItems: 1

EmailDigestSummaryArray

Property Name Type

id^* integer

name^*

string

minLength: 1

enabled^* boolean

KeyValuePair

Property Name	Type
`key^*`	string
`value^*`	string

EmailDigestSummary

Property Name Type

id^* integer

name^*

string

minLength: 1

enabled^* boolean

EmailDigestConfiguration

Property Name Type

enabled^* boolean

EmailDigestName

string

frequency integer
minimum: 1
maximum: 168

EntityMatchingPattern

Entities that match the specified pattern.

Property Name Type Description

matchTo^*

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

matchValue^*

string

minLength: 1

shouldNot

boolean

default: false

Enums

PropertyMatchCriteria

Property Name Type Description

propertyMatchCriteria

string

default: ANY

Enums

ANY

ALL

EntityMatchingPatternEnum

Property Name Type Description

EntityMatchingPatternEnum

string

Enums

STARTS_WITH

ENDS_WITH

CONTAINS

EQUALS

MATCH_REG_EX

PageScopeEnum

Property Name Type Description

PageScopeEnum

string

Enums

ALL_PAGES

SPECIFIC_PAGES

PAGES_MATCHING_PATTERN

VirtualPageScopeEnum

Property Name Type Description

PageScopeEnum

string

Enums

ALL_VIRTUAL_PAGES

SPECIFIC_VIRTUAL_PAGES

VIRTUAL_PAGES_MATCHING_PATTERN

AjaxRequestScopeEnum

Property Name Type Description

AjaxRequestScopeEnum

string

Enums

ALL_AJAX_REQUESTS

SPECIFIC_AJAX_REQUESTS

AJAX_REQUESTS_MATCHING_PATTERN

AjaxRequestScopeEnum

Property Name Type Description

AjaxRequestScopeEnum

string

Enums

ALL_AJAX_REQUESTS

SPECIFIC_AJAX_REQUESTS

AJAX_REQUESTS_MATCHING_PATTERN

SyntheticJobScopeEnum

Property Name Type Description

SyntheticJobScopeEnum

string

Enums

ALL_SYNTHETIC_JOBS

SPECIFIC_SYNTHETIC_JOBS

SYNTHETIC_JOBS_MATCHING_PATTERN

IFrameScopeEnum

Property Name Type Description

IFrameScopeEnum

string

Enums

ALL_IFRAMES

SPECIFIC_IFRAMES

IFRAMES_MATCHING_PATTERN

BusinessTransactionScopeEnum

Property Name Type Description

businessTransactionScope

string

Enums

ALL_BUSINESS_TRANSACTIONS

SPECIFIC_BUSINESS_TRANSACTIONS

BUSINESS_TRANSACTIONS_IN_SPECIFIC_TIERS

BUSINESS_TRANSACTIONS_MATCHING_PATTERN

MobileAppsScopeEnum

Property Name Type Description

MobileAppsScopeEnum

string

Enums

ALL_MOBILE_APPS

SPECIFIC_MOBILE_APPS

MOBILE_APPS_MATCHING_PATTERN

MobileNetworkRequestsScopeEnum

Property Name Type Description

MobileAppsScopeEnum

string

Enums

ALL_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_NETWORK_REQUESTS

SPECIFIC_MOBILE_APPS_NETWORK_REQUESTS

MOBILE_NETWORK_REQUESTS_MATCHING_PATTERN

TierOrNodeScopeEnum

Property Name Type Description

TierOrNodeScope

string

Enums

TIER_SELECTED_ENTITIES

NODE_SELECTED_ENTITIES

SelectedTierScopeEnum

Property Name Type Description

SelectedTierScope

string

Enums

ALL_TIERS

SPECIFIC_TIER

TypeOfNodeEnum

Property Name Type Description

typeofNode

string

Enums

ALL_NODES

JAVA_NODES

DOT_NET_NODES

PHP_NODES

SelectedNodesScopeEnum

Property Name Type Description

selectedNodeScope

string

Enums

ALL_NODES

SPECIFIC_NODES

NODES_OF_SPECIFIC_TIERS

NODES_MATCHING_PATTERN

NODE_PROPERTY_VARIABLE_MATCHER

NodePropertyTypeEnum

Property Name Type Description

NodePropertyTypeEnum

string

Enums

META

ENV

JVM

ErrorScopeEnum

Property Name Type Description

ErrorScopeEnum

string

Enums

ALL_ERRORS

SPECIFIC_ERRORS

ERRORS_OF_SPECIFIC_TIERS

ERRORS_MATCHING_PATTERN

ServiceEndpointScopeEnum

Property Name Type Description

ServiceEndpointScopeEnum

string

Enums

ALL_SERVICE_ENDPOINTS

SPECIFIC_SERVICE_ENDPOINTS

SERVICE_ENDPOINTS_IN_SPECIFIC_TIERS

SERVICE_ENDPOINTS_MATCHING_PATTERN

InformationPointScopeEnum

Property Name Type Description

InformationPointScopeEnum

string

ALL_INFORMATION_POINTS

SPECIFIC_INFORMATION_POINTS

INFORMATION_POINTS_MATCHING_PATTERN

DatabaseTypeEnum

Property Name Type Description

DatabaseTypeEnum

string

ALL_DATABASE_TYPES

COUCHBASE

DB2

MONGO_DB

MICROSOFT_SQL_SERVER

MYSQL

ORACLE

POSTGRE_SQL

AZURE_SQL

SYBASE

ApplicationDatabaseScopeEnum

Property Name Type Description

ApplicationDatabaseScopeEnum

string

ALL_APPLICATION_DATABASES

SPECIFIC_APPLICATION_DATABASES

APPLICATION_DATABASES_MATCHING_PATTERN

ServersScopeEnum

Property Name Type Description

ServersScopeEnum

string

ALL_SERVERS_IN_APPLICATION

SPECIFIC_SERVERS_IN_APPLICATION

ALL_SERVERS_IN_SPECIFIC_TIERS

SpecifiedEntityActionScopeEnum

Property Name Type Description

SpecifiedEntityActionScopeEnum

string

PERCENTAGE

ABSOLUTE

SPECIFIC_NODES

AnomalyEventType

Property Name Type Description

AnomalyEventType

string

Enums

ANOMALY_OPEN_WARNING

ANOMALY_OPEN_CRITICAL

ANOMALY_UPGRADED

ANOMALY_DOWNGRADED

ANOMALY_CLOSE_WARNING

ANOMALY_CLOSE_CRITICAL

ANOMALY_CANCELED_WARNING

ANOMALY_CANCELED_CRITICAL

HealthRuleEventTypeEnum

Property Name Type Description

HealthRuleEventTypeEnum

string

Enums

HEALTH_RULE_CONTINUES_CRITICAL

HEALTH_RULE_OPEN_CRITICAL

HEALTH_RULE_OPEN_WARNING

HEALTH_RULE_UPGRADED

HEALTH_RULE_DOWNGRADED

HEALTH_RULE_CONTINUES_WARNING

HEALTH_RULE_CLOSE_WARNING

HEALTH_RULE_CLOSE_CRITICAL

HEALTH_RULE_CANCELED_WARNING

HEALTH_RULE_CANCELED_CRITICAL

HealthRuleScopeType

Property Name Type Description

HealthRuleScopeType

string

ALL_HEALTH_RULES

SPECIFIC_HEALTH_RULES

OtherEventType

Property Name Type Description

OtherEventType

string

Enums

CLR_CRASH

APPLICATION_CRASH

DEADLOCK

RESOURCE_POOL_LIMIT

APPLICATION_DEPLOYMENT

APP_SERVER_RESTART

APPLICATION_CONFIG_CHANGE

AGENT_CONFIGURATION_ERROR

APPLICATION_DISCOVERED

TIER_DISCOVERED

NODE_DISCOVERED

MACHINE_DISCOVERED

BT_DISCOVERED

SERVICE_ENDPOINT_DISCOVERED

BACKEND_DISCOVERED

EUM_CLOUD_SYNTHETIC_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_CONFIRMED_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_ONGOING_ERROR_EVENT

EUM_CLOUD_SYNTHETIC_PERF_HEALTHY_EVENT

EUM_CLOUD_SYNTHETIC_PERF_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_WARNING_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_CONFIRMED_CRITICAL_EVENT

EUM_CLOUD_SYNTHETIC_PERF_ONGOING_CRITICAL_EVENT

MOBILE_NEW_CRASH_EVENT, SLOW, VERY_SLOW, STALL

ERROR

SelectedEntityType

Property Name Type Description

SelectedEntityType

string

ANY_ENTITY

SPECIFIC_ENTITIES

EntityType

Property Name Type Description

EntityType

string

Enums

BUSINESS_TRANSACTION

TIER_NODE

ERRORS

SERVICE_ENDPOINTS

INFORMATION_POINTS

DATABASES_IN_APPLICATION

SERVERS_IN_APPLICATION

ActionTypeEnum

Property Name Type Description

ActionTypeEnum

string

SMS

EMAIL

CUSTOM_EMAIL

THREAD_DUMP

HTTP_REQUEST

CUSTOM

RUN_SCRIPT_ON_NODES

DIAGNOSTIC_BUSINESS_TRANSACTIONS

CREATE_UPDATE_JIRA

ErrorResponse

Property Name	Type
`statusCode`	integer
`message`	string

^*This property is required.

Download Examples

Download Appdynamics Email Digest Examples.zip to get a set of examples that help you configure an email digest,

Download SWAGGER YAML file

Download the Swagger email_digests_openapi.yml file.