MonthlyUsage
Query monthly usage data aggregated by product for billing insights.
Select
The add-in uses the Talkdesk API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client-side within the add-in.
- AccountId supports the following operators: =, !=, IN, NOT_IN, IS, IS_NOT, CONTAINS, LIKE.
- Month supports the following operators: =, !=, IN, NOT_IN, IS, IS_NOT, CONTAINS, LIKE.
For example, the following query is processed server-side:
SELECT * FROM MonthlyUsage WHERE AccountId = 'value'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier of the usage record. | |
| AccountId | String |
Account.Id | The Talkdesk account identifier. |
| ProductId | String |
Products.Id | The Talkdesk product code. |
| AggrProductId | String | The aggregated product identifier. | |
| Month | String | The year and month of the usage aggregate (e.g. 2023-08). | |
| UsageType | String | The type of usage (AMD, API_REQUEST, CALL, CALL_SERVICE, CREDIT_COMMIT, DIALER, MESSAGE, NUMBER, etc.). | |
| Description | String | A description of the usage type. | |
| Currency | String | The ISO-4217 currency code. | |
| Direction | String | The direction of the interaction (INBOUND, OUTBOUND, OTHER) or null. | |
| Resolution | String | The interaction resolution (ABANDONED, ANSWERED, MACHINE, MISSED, VOICEMAIL, OTHER) or null. | |
| Unit | String | The unit of measure (CHARS, CONVERSATIONS, GB, MINUTES, NUMBERS, PAGES, REQUESTS, SECONDS, SEGMENTS, etc.). | |
| Price | Double | The price per unit. | |
| WalletName | String | The wallet name associated with the usage. | |
| NumberOfUnits | Double | The number of units in the aggregate. | |
| TotalAmount | Double | The total amount in the usage aggregate. |