Alert templates and schema

alertTemplateId	Entity	Owner Details	Parameters	Report Data	Auto Resolvable
unprocessed_events	`N/A`	`N/A`	unprocessedEventParams	unprocessedEventReportData	`FALSE`
usage_breach	`USAGE_METER`	`ACCOUNT`	usageBreachParams	usageBreachReportData	`FALSE`
credit_low_balance	`CREDIT`	`ACCOUNT`	lowBalanceParams	lowBalanceReportData	`TRUE`
wallet_low_balance	`WALLET`	`ACCOUNT`	lowBalanceParams	lowBalanceReportData	`TRUE`
entitlement_low_balance	`FEATURE`	`ACCOUNT`	lowBalanceParams	lowBalanceReportData	`TRUE`
invoice_due_breach	`INVOICE`	`ACCOUNT`	invoiceDueBreachParams	invoiceDueBreachReportData	`FALSE`
invoice_overdue_breach	`INVOICE`	`ACCOUNT`	invoiceDueBreachParams	invoiceDueBreachReportData	`FALSE`
unpaid_invoice_amount_breach	`null`	`ACCOUNT`	unpaidInvoiceAmtBreachParams	unpaidInvoiceAmtBreachReportData	`TRUE`

Parameter Schema

UnprocessedEvent Params:

window

integer

This is the last window number of minutes from alert interval time that will be considered for generating the alert

threshold

integer

required

Threshold limit above which incidents are created

schemaName

integer

Name of the event schema for which unprocessed events count is required

UsageBreach Params:

threshold

integer

required

Threshold limit for a given aggregation period above which alerts are generated.

aggregation

enum

Allowed Values: DAY, WEEK, MONTH, PRICING_CYCLE. Defaults to PRICING_CYCLE

LowBalance Params:

minThreshold

integer

required

Minimum threshold limit below which incidents are created

InvoiceDueBreach Params:

thresholdDays

integer

required

Threshold limit for days above which incidents are created

thresholdSum

integer

Threshold limit for invoice sum above which incidents are created

UnpaidInvoiceAmountBreach Params:

thresholdSum

integer

required

Threshold limit for unpaid invoice sum above which incidents are created

Report Data Schema

UnprocessedEvent Report Data:

count

integer

required

Count of the unprocessed events

UsageBreach Report Data:

usage

integer

required

Usage units

LowBalance Report Data:

balance

integer

required

Remaining balance of credits for an account

totalGrantedUnits

integer

Total granted units of credits for an account

accountId

string

accountId corresponding to the alert

InvoiceDueBreach Report Data:

count

integer

required

Sum of all invoices that are due / overdue after threshold number of days

sum

integer

Count of invoices that are due / overdue after threshold number of days”

accountId

string

accountId corresponding to the alert

UnpaidInvoiceAmountBreach Report Data:

sum

number

required

Sum of the total unpaid amount

accountId

string

required

accountId corresponding to the alert

sumOfDueInvoices

number

required

Sum of the due invoices contributing to the outstanding sum

sumOfDraftInvoices

number

required

Sum of the draft invoices contributing to the outstanding sum

numberOfDueInvoices

integer

required

Number of due invoices contributing to the outstanding sum

numberOfDraftInvoices

integer

required

Number of draft invoices contributing to the outstanding sum

sumOfPartiallyPaidInvoices

number

required

Sum of the partially paid invoices contributing to the outstanding sum

numberOfPartiallyPaidInvoices

integer

required

Number of partially paid invoices contributing to the outstanding sum

Introduction

APIs

Parameter Schema

UnprocessedEvent Params:

UsageBreach Params:

LowBalance Params:

InvoiceDueBreach Params:

UnpaidInvoiceAmountBreach Params:

Report Data Schema

UnprocessedEvent Report Data:

UsageBreach Report Data:

LowBalance Report Data:

InvoiceDueBreach Report Data:

UnpaidInvoiceAmountBreach Report Data:

Introduction

APIs

​Parameter Schema

​UnprocessedEvent Params:

​UsageBreach Params:

​LowBalance Params:

​InvoiceDueBreach Params:

​UnpaidInvoiceAmountBreach Params:

​Report Data Schema

​UnprocessedEvent Report Data:

​UsageBreach Report Data:

​LowBalance Report Data:

​InvoiceDueBreach Report Data:

​UnpaidInvoiceAmountBreach Report Data:

Parameter Schema

UnprocessedEvent Params:

UsageBreach Params:

LowBalance Params:

InvoiceDueBreach Params:

UnpaidInvoiceAmountBreach Params:

Report Data Schema

UnprocessedEvent Report Data:

UsageBreach Report Data:

LowBalance Report Data:

InvoiceDueBreach Report Data:

UnpaidInvoiceAmountBreach Report Data: