On this page
No Headings
objectalertsarrayList of alerts
itemsobjectidstringUnique identifier for the alert, assigned by the system upon creation.
external_subscription_idstringExternal identifier of the subscription that this alert is monitoring.
metricobjectnamerequiredstringDescriptive name of the metric that represents a pricing component of your application. This is primarily used for display purposes in the user interface.
coderequiredstringUnique 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.
typestring"METERED", "RECURRING""RECURRING"Type of metric, either 'metered' for usage-based or 'recurring' for fixed periodic charges.
descriptionstringOptional 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_typerequiredstring | null"COUNT", "SUM", "MAX", "COUNT_DISTINCT", "LATEST"Aggregation type for the metric
aggregation_fieldstringProperty 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.
field_filtersarrayitemsobjectkeyrequiredstringProperty name within the event payload that will be used for filtering. This allows you to segment usage data based on specific event properties, such as region, tier, or any other dimension you track.
valuesrequiredarrayArray of specific values that the system should match against the filter key. Only events with matching key-value pairs will be included in the metric calculations. This enables differentiated pricing based on dimensions like region, environment, or other custom properties.
itemsstringidrequiredstringUnique identifier of the metric, automatically generated by the system upon creation. This ID is used internally to track the metric and cannot be modified.
created_atrequiredobjectdate-timeThe date and time when the metric was created. ISO 8601 format with timezone.
updated_atobjectdate-timeThe date and time when the metric was last updated. ISO 8601 format with timezone.
typestring"CURRENT_USAGE_AMOUNT", "METRIC_CURRENT_USAGE_AMOUNT", "METRIC_CURRENT_USAGE_UNITS", "LIFETIME_USAGE_AMOUNT"Type of alert
codestringThe unique code to identify the alert within a subscription. Used in API endpoints for operations on specific alerts.
namestringHuman-readable display name for the alert. Used for identification in user interfaces.
previous_valuenumberThe usage value from the last time this alert was evaluated. For monetary alerts, this represents currency amount; for unit alerts, this represents consumed units.
last_processed_atobjectdate-timeThe date and time when this alert was last evaluated by the system. Null for newly created alerts that haven't been processed yet. The system evaluates alerts at regular intervals (typically every 5 minutes) to check if usage has crossed any configured thresholds.
thresholdsarrayList of configured thresholds that trigger this alert. Includes both one-time and recurring thresholds.
itemsobjectcodestringIdentifier for this threshold. Used to distinguish between different thresholds.
valuerequiredstring^[0-9]+\.?[0-9]*$A value that should trigger this alert. Must be a positive numeric string that can include a decimal point.
recurringbooleanWhen 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.
created_atobjectdate-timeThe date and time when the alert was created.
metaobjecttotal_countintegertotal_pagesintegercurrent_pageinteger