AlertList

Descriptive name of the metric that represents a pricing component of your application. This is primarily used for display purposes in the user interface.

Unique code used to identify the metric within your system. This code is used in API requests to associate events with the correct metric and must be unique across all metrics. Once created, this code cannot be changed.

Type of metric, either 'metered' for usage-based or 'recurring' for fixed periodic charges.

Optional detailed description of the metric that provides additional context about what the metric measures and how it's used. This information is for internal use and helps document the purpose of the metric.

Aggregation type for the metric

Property name within the event payload that will be used for aggregating usage data. This field specifies which value from the event should be used for calculations. It is required for aggregation types like 'SUM', 'MAX', and other types that operate on values, but not required for 'COUNT' aggregation.

Unique identifier of the metric, automatically generated by the system upon creation. This ID is used internally to track the metric and cannot be modified.

The date and time when the metric was created. ISO 8601 format with timezone.

The date and time when the metric was last updated. ISO 8601 format with timezone.

Identifier for this threshold. Used to distinguish between different thresholds.

A value that should trigger this alert. Must be a positive numeric string that can include a decimal point.

When true, enables retriggering of alerts at specified intervals after the last non-recurring threshold is exceeded. For example, with non-recurring thresholds at 500 and 1000, and a recurring threshold of 200, alerts will fire at 500, 1000, then every 200 thereafter (1200, 1400, etc.). Only one recurring threshold permitted per alert.