Preview Alert Notification

Preview Alert Notification

Get all the notification preview for a specific alert

Request
URI
POST
https://{api_host}/api/v2/alert/preview
COPY
Request Body
Alert of type(s) application/json
Optional
{
    "tagpaths": [
        "string"
    ],
    "targetEndpoints": [
        "string"
    ],
    "modifyAclAccess": false,
    "lastEventTime": 0,
    "hidden": false,
    "severity": "string",
    "minutes": 0,
    "name": "string",
    "id": "string",
    "target": "string",
    "application": [
        "string"
    ],
    "service": [
        "string"
    ],
    "createdEpochMillis": 0,
    "updatedEpochMillis": 0,
    "targetInfo": [
        {
            "method": "string",
            "id": "string",
            "name": "string"
        }
    ],
    "systemOwned": false,
    "tags": {
        "customerTags": [
            "string"
        ]
    },
    "status": [
        "string"
    ],
    "event": {
        "computedHlps": [
            {
                "severity": "string",
                "host": "string",
                "startTime": 0,
                "label": "string",
                "observed": 0,
                "firing": 0
            }
        ],
        "table": "string",
        "name": "string",
        "id": "string",
        "startTime": 0,
        "endTime": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "tags": [
            "string"
        ],
        "metricsUsed": [
            "string"
        ],
        "createdAt": 0,
        "hosts": [
            "string"
        ],
        "summarizedEvents": 0,
        "alertTags": [
            "string"
        ],
        "isUserEvent": false,
        "isEphemeral": false,
        "creatorId": "string",
        "updaterId": "string",
        "updatedAt": 0,
        "runningState": "string",
        "canDelete": false,
        "canClose": false,
        "creatorType": [
            "string"
        ]
    },
    "orphan": false,
    "deleted": false,
    "acl": {
        "canView": [
            "string"
        ],
        "canModify": [
            "string"
        ]
    },
    "created": 0,
    "processRateMinutes": 0,
    "createUserId": "string",
    "updated": 0,
    "updateUserId": "string",
    "queryFailing": false,
    "lastFailedTime": 0,
    "lastErrorMessage": "string",
    "additionalInformation": "string",
    "metricsUsed": [
        "string"
    ],
    "hostsUsed": [
        "string"
    ],
    "inTrash": false,
    "lastProcessedMillis": 0,
    "pointsScannedAtLastQuery": 0,
    "includeObsoleteMetrics": false,
    "lastQueryTime": 0,
    "condition": "string",
    "conditionQueryType": "string",
    "conditionQBEnabled": false,
    "conditionQBSerialization": "string",
    "displayExpression": "string",
    "displayExpressionQueryType": "string",
    "displayExpressionQBEnabled": false,
    "creatorId": "string",
    "updaterId": "string",
    "displayExpressionQBSerialization": "string",
    "alertSources": [
        {
            "hidden": false,
            "color": "string",
            "name": "string",
            "query": "string",
            "description": "string",
            "queryType": "string",
            "queryBuilderEnabled": false,
            "queryBuilderSerialization": "string",
            "alertSourceType": [
                "string"
            ]
        }
    ],
    "resolveAfterMinutes": 0,
    "snoozed": 0,
    "failingHostLabelPairs": [
        {
            "severity": "string",
            "host": "string",
            "startTime": 0,
            "label": "string",
            "observed": 0,
            "firing": 0
        }
    ],
    "querySyntaxError": false,
    "runbookLinks": [
        "string"
    ],
    "triageDashboards": [
        {
            "dashboardId": "string",
            "description": "string"
        }
    ],
    "alertTriageDashboards": [
        {
            "dashboardId": "string",
            "description": "string"
        }
    ],
    "inMaintenanceHostLabelPairs": [
        {
            "severity": "string",
            "host": "string",
            "startTime": 0,
            "label": "string",
            "observed": 0,
            "firing": 0
        }
    ],
    "activeMaintenanceWindows": [
        "string"
    ],
    "prefiringHostLabelPairs": [
        {
            "severity": "string",
            "host": "string",
            "startTime": 0,
            "label": "string",
            "observed": 0,
            "firing": 0
        }
    ],
    "notificants": [
        "string"
    ],
    "lastNotificationMillis": 0,
    "notificationResendFrequencyMinutes": 0,
    "alertsLastDay": 0,
    "alertsLastWeek": 0,
    "alertsLastMonth": 0,
    "numPointsInFailureFrame": 0,
    "noDataEvent": {
        "computedHlps": [
            {
                "severity": "string",
                "host": "string",
                "startTime": 0,
                "label": "string",
                "observed": 0,
                "firing": 0
            }
        ],
        "table": "string",
        "name": "string",
        "id": "string",
        "startTime": 0,
        "endTime": 0,
        "createdEpochMillis": 0,
        "updatedEpochMillis": 0,
        "tags": [
            "string"
        ],
        "metricsUsed": [
            "string"
        ],
        "createdAt": 0,
        "hosts": [
            "string"
        ],
        "summarizedEvents": 0,
        "alertTags": [
            "string"
        ],
        "isUserEvent": false,
        "isEphemeral": false,
        "creatorId": "string",
        "updaterId": "string",
        "updatedAt": 0,
        "runningState": "string",
        "canDelete": false,
        "canClose": false,
        "creatorType": [
            "string"
        ]
    },
    "systemAlertVersion": 0,
    "alertType": "string",
    "evaluateRealtimeData": false,
    "secureMetricDetails": false,
    "enablePDIncidentBySeries": false,
    "chartSettings": {
        "type": "string",
        "min": "number",
        "max": "number",
        "customTags": [
            "string"
        ],
        "expectedDataSpacing": 0,
        "fixedLegendEnabled": false,
        "fixedLegendUseRawStats": false,
        "plainMarkdownContent": "string",
        "lineType": "string",
        "stackType": "string",
        "windowing": "string",
        "windowSize": 0,
        "showHosts": false,
        "showLabels": false,
        "showRawValues": false,
        "showValueColumn": false,
        "autoColumnTags": false,
        "columnTags": "string",
        "tagMode": "string",
        "numTags": 0,
        "groupBySource": false,
        "sortValuesDescending": false,
        "defaultSortColumn": "string",
        "y1Max": "number",
        "y1Min": "number",
        "y1Units": "string",
        "y0ScaleSIBy1024": false,
        "y1ScaleSIBy1024": false,
        "y0UnitAutoscaling": false,
        "y1UnitAutoscaling": false,
        "invertDynamicLegendHoverControl": false,
        "fixedLegendPosition": "string",
        "fixedLegendDisplayStats": [
            "string"
        ],
        "fixedLegendFilterSort": "string",
        "fixedLegendShowSourceName": false,
        "fixedLegendShowMetricName": false,
        "fixedLegendFilterLimit": 0,
        "fixedLegendFilterField": "string",
        "fixedLegendHideLabel": false,
        "xmax": "number",
        "xmin": "number",
        "ymax": "number",
        "ymin": "number",
        "timeBasedColoring": false,
        "sparklineDisplayValueType": "string",
        "sparklineDisplayColor": "string",
        "sparklineDisplayVerticalPosition": "string",
        "sparklineDisplayHorizontalPosition": "string",
        "sparklineDisplayFontSize": "string",
        "sparklineDisplayPrefix": "string",
        "sparklineDisplayPostfix": "string",
        "sparklineSize": "string",
        "sparklineLineColor": "string",
        "sparklineFillColor": "string",
        "sparklineValueColorMapColors": [
            "string"
        ],
        "sparklineValueColorMapValuesV2": [
            "number"
        ],
        "sparklineValueColorMapValues": [
            0
        ],
        "sparklineValueColorMapApplyTo": "string",
        "sparklineDecimalPrecision": 0,
        "sparklineValueTextMapText": [
            "string"
        ],
        "sparklineValueTextMapThresholds": [
            "number"
        ],
        "chartDefaultColor": "string",
        "logsTable": {
            "columns": [
                "string"
            ]
        }
    },
    "ingestionPolicyId": "string",
    "failingHostLabelPairLinks": [
        "string"
    ],
    "sortAttr": 0,
    "severityList": [
        "string"
    ],
    "alertChartUnits": "string",
    "alertChartBase": 0,
    "alertChartDescription": "string"
}
array of string
tagpaths
Optional

tagpaths

array of string
targetEndpoints
Optional

targetEndpoints

boolean
modifyAclAccess
Optional

Whether the user has modify ACL access to the alert.

integer As int64 As int64
lastEventTime
Optional

Start time (in epoch millis) of the last event associated with this alert.

boolean
hidden
Optional

hidden

string
severity
Optional

Severity of the alert

Possible values are : INFO, SMOKE, WARN, SEVERE,
integer As int32 As int32
minutes
Required

The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires

string
name
Required

name

string
id
Optional

id

string
target
Optional

The email address or integration endpoint (such as PagerDuty or web hook) to notify when the alert status changes. Comma-separated list of targets. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert target ID}). You cannot update this value.

array of string
application
Optional

Lists the applications from the failingHostLabelPair of the alert.

array of string
service
Optional

Lists the services from the failingHostLabelPair of the alert.

integer As int64 As int64
createdEpochMillis
Optional

createdEpochMillis

integer As int64 As int64
updatedEpochMillis
Optional

updatedEpochMillis

array of TargetInfo
targetInfo
Optional

List of alert targets display information that includes name, id and type.

boolean
systemOwned
Optional

Whether this alert is system-owned and not writeable

tags
Optional

tags

array of string
status
Optional

Lists the current state of the alert. Can be one or more of: FIRING,SNOOZED, IN_MAINTENANCE, INVALID, NONE, CHECKING, TRASH, NO_DATA

event
Optional

event

boolean
orphan
Optional

orphan

boolean
deleted
Optional

deleted

acl
Optional

acl

integer As int64 As int64
created
Optional

When this alert was created, in epoch millis

integer As int32 As int32
processRateMinutes
Optional

The interval between checks for this alert, in minutes. Defaults to 1 minute

string
createUserId
Optional

createUserId

integer As int64 As int64
updated
Optional

When the alert was last updated, in epoch millis

string
updateUserId
Optional

The user that last updated this alert

boolean
queryFailing
Optional

Whether there was an exception when the alert condition last ran

integer As int64 As int64
lastFailedTime
Optional

The time of the last error encountered when running this alert's condition query, in epoch millis

string
lastErrorMessage
Optional

The last error encountered when running this alert's condition query

string
additionalInformation
Optional

User-supplied additional explanatory information for this alert. Useful for linking runbooks, mitigations,, etc

array of string
metricsUsed
Optional

Number of metrics checked by the alert condition

array of string
hostsUsed
Optional

Number of hosts checked by the alert condition

boolean
inTrash
Optional

inTrash

integer As int64 As int64
lastProcessedMillis
Optional

The time when this alert was last checked, in epoch millis

integer As int64 As int64
pointsScannedAtLastQuery
Optional

A derived field recording the number of data points scanned when the system last computed this alert's condition

boolean
includeObsoleteMetrics
Optional

Whether to include obsolete metrics in alert query

integer As int64 As int64
lastQueryTime
Optional

Last query time of the alert, averaged on hourly basis

string
condition
Required

A Wavefront query that is evaluated at regular intervals (default 1m). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes

string
conditionQueryType
Optional

conditionQueryType

Possible values are : WQL, PROMQL, HYBRID,
boolean
conditionQBEnabled
Optional

Whether the condition query was created using the Query Builder. Default false

string
conditionQBSerialization
Optional

The special serialization of the Query Builder that corresponds to the condition query. Applicable only when conditionQBEnabled is true

string
displayExpression
Optional

A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted

object
conditions
Optional

Multi - alert conditions.

string
displayExpressionQueryType
Optional

displayExpressionQueryType

Possible values are : WQL, PROMQL, HYBRID,
boolean
displayExpressionQBEnabled
Optional

Whether the display expression query was created using the Query Builder. Default false

string
creatorId
Optional

creatorId

string
updaterId
Optional

updaterId

string
displayExpressionQBSerialization
Optional

The special serialization of the Query Builder that corresponds to the display expression query. Applicable only when displayExpressionQBEnabled is true

alertSources
Optional

A list of queries represent multiple queries in alert. It must contains at least one query with AlertSourceType as CONDITION.

integer As int32 As int32
resolveAfterMinutes
Optional

The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as "minutes"

object
targets
Optional

Targets for severity.

integer As int64 As int64
snoozed
Optional

The until which time this alert is snoozed (not checked), in epoch millis. A negative value implies the alert is snoozed indefinitely

failingHostLabelPairs
Optional

Failing host/metric pairs

boolean
querySyntaxError
Optional

Whether there was an query syntax exception when the alert condition last ran

array of string
runbookLinks
Optional

User-supplied runbook links for this alert. Useful for linking wiki page or documentation, etc to refer to when alert is triggered

triageDashboards
Optional

Deprecated for alertTriageDashboards

alertTriageDashboards
Optional

User-supplied dashboard and parameters to create dashboard links. Parameters must be specified as constants or variables. Constant parameters currently only supported

inMaintenanceHostLabelPairs
Optional

Lists the sources that will not be checked for this alert, due to matching a maintenance window

array of string
activeMaintenanceWindows
Optional

The names of the active maintenance windows that are affecting this alert

prefiringHostLabelPairs
Optional

Lists the series that are starting to fail, defined as failing for greater than 50% of the checks in the window determined by the "minutes" parameter

array of string
notificants
Optional

A derived field listing the webhook ids used by this alert

integer As int64 As int64
lastNotificationMillis
Optional

When this alert last caused a notification, in epoch millis

integer As int64 As int64
notificationResendFrequencyMinutes
Optional

How often to re-trigger a continually failing alert. If absent or <= 0, no retriggering occurs

integer As int32 As int32
alertsLastDay
Optional

alertsLastDay

integer As int32 As int32
alertsLastWeek
Optional

alertsLastWeek

integer As int32 As int32
alertsLastMonth
Optional

alertsLastMonth

integer As int32 As int32
numPointsInFailureFrame
Optional

Number of points scanned in alert query time frame.

noDataEvent
Optional

noDataEvent

integer As int32 As int32
systemAlertVersion
Optional

If this is a system alert, the version of it

string
alertType
Optional

Alert type.

Possible values are : CLASSIC, THRESHOLD,
boolean
evaluateRealtimeData
Optional

Whether to alert on the real-time ingestion stream (may be noisy due to late data)

boolean
secureMetricDetails
Optional

Whether to secure sensitive metric details and alert images in alert notifications, to not break Metrics Security.

boolean
enablePDIncidentBySeries
Optional

enablePDIncidentBySeries

chartSettings
Optional

chartSettings

chartAttributes
Optional

chartAttributes

string
ingestionPolicyId
Optional

Get the ingestion policy Id associated with ingestion policy alert.

array of string
failingHostLabelPairLinks
Optional

List of links to tracing applications that caused a failing series

integer As int32 As int32
sortAttr
Optional

Attribute used for default alert sort that is derived from state and severity

array of string
severityList
Optional

Alert severity list for multi-threshold type.

Possible values are : INFO, SMOKE, WARN, SEVERE,
string
alertChartUnits
Optional

The y-axis unit of Alert chart.

integer As int32 As int32
alertChartBase
Optional

The base of alert chart. A linear chart will have base as 1. A logarithmic chart will have the other base value.The value should be an integer and should greater than or equal to 1.

string
alertChartDescription
Optional

The description of alert chart. Different from alert additional info, this is used to describe the characteristics of the chart.

Authentication
This operation uses the following authentication methods.
Responses
200

successful operation

Returns ResponseContainerListNotification_Messages of type(s) application/json
{
    "status": {
        "result": "string",
        "message": "string",
        "code": 0
    },
    "response": [
        {
            "name": "string",
            "method": "string",
            "id": "string",
            "content": "string",
            "createdEpochMillis": 0,
            "updatedEpochMillis": 0,
            "deleted": false,
            "creatorId": "string",
            "updaterId": "string",
            "subject": "string"
        }
    ]
}
status
Required

status

response
Optional

response