This event tracks the usage of connectivity resources (data, SMS, and voice) across an entire organization. It will trigger when the usage exceeds a threshold defined in the event. This event is evaluated hourly to determine if the thresholds have been reached, thus there is no real-time configuration of this event.The organization usage change event is triggered when the aggregate usage of data, voice, or SMS crosses a defined threshold limit.
Form
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Usage type | String | Yes | Type of usage to be filtered by,
options are: Data - Data usage in megabytes as reported by the CDRs, this value is synchronized from carriers daily. Data (Estimated) - Data usage in megabytes as reported via RADIUS. This value updates in real-time, but is not guaranteed to be accurate. SMS - SMS usage as reported by the CDRs, this value is synchronized from carriers daily. Voice - Voice minutes usage as reported by the CDRs, this value is synchronized from carriers daily. |
| Time period | String | Yes | Month to date - Evaluate the usage
of the connection in the current
billing month. Last time period - Evaluate the usage since the last X amount of time in seconds (s), minutes (m), hours (h) or days (d). |
| Usage threshold value | Number | A minimum limit for the usage in megabytes (for data), number of messages for SMS, and minutes for voice. If this value is specified, the value compared against the connection usage to execute the trigger. If the threshold is set to 10, the value of the current connection's usage must exceed 10 MB(10.01, 11, or 99, for example). | |
| Notification frequency | String | Yes | The frequency that this event will re-execute once the condition is met. Setting this value to 7d means that after the condition is met, the trigger will not fire again until 7 days pass and the condition is true again. The format is a number followed by m (minutes), h (hours), d (days). The maximum period is 30 days. Examples: 24h, 7d, 30d, 120m. |
| Connection tags | String | This trigger can be limited to connections specified by tags. Leave blank to not limit this trigger to connections specified by tag. When multiple tags are specified in the trigger event, the connection must have at least one tag in common for the trigger to execute. | |
| Filter MCC/MNC | String | It allows filtering the usage change results by MCC/MNC |
Event variables
|
Name
|
Type
|
Description
|
|---|---|---|
| $(event.threshold) | String | The threshold configured by the user. |
| $(event.usage) | String | The end usage block that caused the trigger to execute. For example, if you set the trigger to execute when it reaches 100MB in 7d (7 days). The usage reaches 97 MB is 3 days and in the 4th day it uses 5MB, the $(event.usage) is 5MB. |
| $(event.since) | String | The beginning of the time range evaluated to determine the usage. If the Last period is configured as 7d, then since will be 7 days prior to the current date. |
| $(event.ts) | String | The timestamp of the connection status change that initiated this trigger. |