Table 5. API Resources for Analytics That Are Based on the Billing Account
|
|
|
|
GET |
/analytics/accounts |
period |
Returns the overview summary of the account that the current user can access for a particular period. If no period ID is passed, then the data for the latest period that has data loaded is returned. The period must be the period name returned from a call to the /periods service. |
GET |
/analytics/accounts/{accountId}/summary |
parameter(chartId), reportPeriodStart, reportPeriodEnd |
Returns the account summary. The account_id can be retrieved from the response of the
/analytics/accounts service. |
POST |
/analytics/accounts/{accountId}/summary/batchrpts |
parameter(chartId), reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Account Billing Overview report. |
GET |
/analytics/accounts/{accountId}/amountDue |
Amount Due(AmountDue) |
Returns the current amount due for an account, which can be different from the statement due. The accountId can be retrieved from the response of the /analytics/accounts service. |
GET |
/analytics/accounts/{accountId}/billingTrend |
reportPeriodStart, reportPeriodEnd |
Returns the account billing trend for the period specified. The value of accountId can be retrieved from the response of the /analytics/accounts service. |
POST |
/analytics/accounts/{accountId}/billingTrend/batchrpts |
reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Account Billing Trend report. |
GET |
/analytics/accounts/{accountId}/unbilledSummary |
None |
Returns an unbilled usage summary for an account. |
GET |
/analytics/accounts/{accountId}/unbilledSummaryByService |
None |
Returns an unbilled usage summary for an account by service |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/unbilledByPlan |
None |
Returns the unbilled usage plan for a service. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/unbilledDetails |
parameter(TariffKey),
parameter(Usage
TypeKey) |
Returns the unbilled usage transaction details for a tariff. |
GET |
/analytics/accounts/{accountId}/serviceAgreements |
period |
Returns a list of service agreements for a particular account. If no period is passed, the data for the latest period that has billing data loaded is returned. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/overview |
period |
Returns the Service Billing Overview for all service agreements within the account. |
POST |
/analytics/accounts/{accountId}/serviceAgreements/overview/batchrpts |
period |
Creates a batch report schedule request for the Service Billing Overview for all service agreements in the account report. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/overview |
reportPeriodStart, reportPeriodEnd |
Returns a Service Overview for a given service number. |
POST |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/overview/batchrpts |
reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Service Overview for a given service number. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/details |
reportPeriodStart, reportPeriodEnd, parameter
(usageType) |
Returns service details. |
POST |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/details/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(usageType) |
Creates a batch report schedule request for the Service Details report. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/transactionDetails |
serviceDetailKey |
Returns the transaction details for a service agreement. The value of {service_number} is available from the call to the
/analytics/accounts/{accountId}/serviceAgreements service. |
GET |
/analytics/accounts/{accountId}/serviceAgreements/{serviceNumber}/usageTrend |
reportPeriodStart, reportPeriodEnd |
Returns the usage trend for a service agreement. The value of {service_number} is available from the call to the /analytics/accounts/{accountId}/serviceAgreements service. |
GET |
/analytics/accounts/{accountId}/highestSpendingServices |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Returns the highest spending services for an account. |
POST |
/analytics/accounts/{accountId}/highestSpendingServices/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter
(numResults) |
Creates a batch report schedule request for the Highest Spending Services report. |
GET |
/analytics/accounts/{accountId}/mostExpensiveCalls |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Returns the most expensive calls for an account. |
POST |
/analytics/accounts/{accountId}/mostExpensiveCalls/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Creates a batch report schedule request for the Most Expensive Calls report. |
GET |
/analytics/accounts/{accountId}/longestCalls |
reportPeriodStart, reportPeriodEnd, parameter
(numResults) |
Returns the longest calls for an account. |
POST |
/analytics/accounts/{accountId}/longestCalls/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Creates a batch report schedule request for the Longest Calls report. |
GET |
/analytics/accounts/{accountId}/mostFrequentlyCalledNumber |
reportPeriodStart, reportPeriodEnd, parameter
(numResults) |
Returns the most frequently called numbers for an account. |
POST |
/analytics/accounts/{accountId}/mostFrequentlyCalledNumbers/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Creates a batch report schedule request for the Most Frequently Called Numbers report. |
GET |
/analytics/accounts/{accountId}/mostFrequentlyCalledDestinations |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Returns the most frequently called destinations for an account. |
POST |
/analytics/accounts/{accountId}/mostFrequentlyCalledDestinations/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Creates a batch report schedule request for the Most Frequently Called Destinations report. |
GET |
/analytics/accounts/{accountId}/mostFrequentlyCalledCountries |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Returns the most frequently called countries for an account. |
POST |
/analytics/accounts/{accountId}/mostFrequentlyCalledCountries/batchrpts |
reportPeriodStart, reportPeriodEnd,
parameter
(numResults) |
Creates a batch report schedule request for Most Frequently Called Countries report. |
