---
title: "Alert Email Macros"
slug: "alert-email-macros"
updated: 2023-01-05T23:20:20Z
published: 2023-01-05T23:20:20Z
canonical: "docs.catchpoint.com/alert-email-macros"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.catchpoint.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Alert Email Macros

| **Reserved-Keyword** | **Description** | **Subject Permitted?** |
| --- | --- | --- |
| AlertCreateDateLocal | Displays the local timestamp in which the alert-notification records was inserted into the database (in "MM/DD/YYYY HH:MI:SS AMPM" format). | Y |
| AlertCreateDateUtc | Displays the UTC timestamp in which the alert-notification records was inserted into the database (in "MM/DD/YYYY HH:MI:SS AMPM" format). | Y |
| AlertGroupId | Displays the Alert-Group's ID. | Y |
| AlertGroupItemId | Displays the Alert-Group-Item's ID. | Y |
| AlertGroupName | Displays the Alert-Group's Name. | Y |
| AlertGroupItemStepTypeId | Displays the Alert-Group-Item's Step-Type-ID (1=Index, 2=Name, 3=Address). | Y |
| AlertGroupItemStepTypeValue | Displays the Alert-Group-Item's Step-Type-Value (only applies to non-zero Step-Type-IDs). | Y |
| AlertProcessingTimestampUtc | Displays the backend, processing UTC timestamp in which the alert occurred (in "MM/DD/YYYY HH:MI:SS" format). | Y |
| AlertScatterplotImageUrl | Displays the alert-scatterplot image-URL |  |
| AlertThreshold | Displays the Alert-Group-Item's threshold. | Y |
| AlertThresholdPercentage | Displays the Alert-Group-Item's threshold-percentage, using 3-decimal places. | Y |
| AlertThresholdUsesOrOperator | Displays the Alert-Group-Item's threshold-uses-OR-operator as "true" or "false" (in English only). | Y |
| AlertTriggerLevel | Displays the enumerated Alert Trigger-Level (0=Warning, 1=Critical, 2=Information) | Y |
| AlertTriggerPercentage | Displays the Alert Trigger-Percentage, using 3-decimal places. | Y |
| AlertTriggerTotal | Displays the Alert Trigger-Total. | Y |
| AlertTriggerType | Displays the enumerated Alert Trigger-Type (in English only). | Y |
| AlertType | Displays the enumerated Alert-Type (in English only). | Y |
| ClientId | Displays the Client's ID. | Y |
| ClientName | Displays the Client's name. | Y |
| CustomTestDataSource | Displays the enumerated Insight Data Source-Type (0-=HTTP Header, 1=HTTP Content) | Y |
| CustomTestDataType | Displays the enumerated Insight Data-Type (0=Tracepoint, 1=Indicator) | Y |
| CustomTestDataName | Displays the Insight data name. | Y |
| DiagnosticDetails | Displays the debug-on-error diagnostic details. |  |
| DivisionId | Displays the Division's ID. | Y |
| DivisionName | Displays the Division's name. | Y |
| HistoricalReportTimeIntervalCount | Displays the Alert-Group-Item's historical-report-time-interval count. | Y |
| HostIP | Displays the 1 to 5 "Host" IP addresses from the given node-based alert data. | Y |
| MonitorType | Displays the enumerated Monitor-Type (in English only). | Y |
| NodeThresholdType | Displays the Node-Threshold Type. | Y |
| ReportDate | Displays the Schedule-Window date (UTC). | Y |
| ReportDateLocal | Displays the Schedule-Window date (Local). | Y |
| ReportTimeInterval | Displays the Alert-Group-Item's enumerated report-time-interval (in English only). | Y |
| PerformanceChartUrl | Displays a link to the UI's performance-chart. |  |
| ProductId | Displays the Product's ID. | Y |
| ProductName | Displays the Product's name. | Y |
| TestId | Displays the Test's ID. | Y |
| TestName | Displays the Test's name. | Y |
| TestPath | Displays the Test-Folder path, enclosed in double-quotes, separated by ">" characters. Please note: This will only work properly when tests are created in a Folder. | Y |
| TestVersion | Displays the Test's version. | Y |
| TestUrl | Displays the Test's URL. | Y |
| ThresholdReportTimeIntervalCount | Displays the Alert-Group-Item's threshold-report-time-interval count. | Y |
| TriggerOperatorType | Displays the Alert-Group-Item's enumerated trigger-operator-type (in English only). | Y |
| TriggerRangeEnd | Displays the Alert-Group-Item's trigger-range-end (only set when the BETWEEN or NOT-BETWEEN operators are used). | Y |
| TriggerRangeStart | Displays the Alert-Group-Item's trigger-range-start. | Y |
| TriggerRegexMatch | Displays the Alert-Group-Item's trigger-regex-match (which is only set for content or header matching). | Y |
| Time | It returns UTC time stamp for the time at the node where the test ran in YYYYMMDDHHMISSMSC format (17 characters long). | Y |
| TimeTrim | Same as “time”, however customized format values will be trimmed (i.e., no “zero” padding) in its date-time components. | Y |
| TimeDay | The UTC date for the time at the node where the test ran in YYYYMMDD format (8 characters long). | Y |
| TimeEpoch | The epoch time stamp for the time at the node where the test ran. Epoch time stamp is the number of seconds since 01/01/1970 12AM UTC. The format for epoch time stamp is 1234567890. | Y |
| TimeFormat | Inserts the UTC time stamp for the time at the node where the test ran using the format specified. | Y |