Table 4. API Resources for Analytics That Are Based on the Billing Account
|
|
Additional Input Parameters |
|
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 ETL data loaded is returned. The period must be the period name returned from a call to the /periods service. |
GET |
/analytics/{account_id}/summary |
reportPeriodStart, reportPeriodEnd |
Returns the account summary. The account_id can be retrieved from the response of the /analytics/accounts service. |
GET |
/analytics/{account_id}/amount_due |
None |
Returns the current amount due for an account, which can be different from the statement due. The account_id can be retrieved from the response of the /analytics/accounts service. |
GET |
/analytics/{account_id}/billing_trend |
reportPeriodStart, reportPeriodEnd |
Returns the account billing trend for the period specified. The value of {account_id} can be retrieved from the response of the /analytics/accounts service. |
GET |
/analytics/{account_id}/service_agreements |
period |
Returns the list of service agreements for a particular account. The value of {account_id} can be retrieved from the response of the /analytics/accounts service. |
GET |
/analytics/{account_id}/service_agreements/{service_number}/overview |
reportPeriodStart, reportPeriodEnd |
Returns the service overview for a particular service agreement number. The value of {service_number} is available from the call to the /analytics/{account_id}/service_agreements service. |
GET |
/analytics/{account_id}/service_agreements/{service_number}/details |
reportPeriodStart, reportPeriodEnd, parameter(usage Type) |
Returns the service details. The value of {service_number} is available from the call to the /analytics/{account_id}/service_agreements service. |
GET |
/analytics/{account_id}/service_agreements/{service_number}/transaction_details |
serviceDetailKey |
Returns the transaction details for a service agreement. The value of {service_number} is available from the call to the /analytics/{account_id}/service_agreements service. |
GET |
/analytics/{account_id}/service_agreements/{service_number}/usage_trend |
reportPeriodStart, reportPeriodEnd |
Returns the usage trend for a service agreement. The value of {service_number} is available from the call to the /analytics/{account_id}/service_agreements service. |
GET |
/analytics/{account_id}/topx/highest_spending _services |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the highest spending services for an account. |
GET |
/analytics/{account_id}/topx/most_expensive_ calls |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the most expensive calls for an account. |
GET |
/analytics/{account_id}/topx/longest_calls |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the longest calls for an account. |
GET |
/analytics/{account_id}/topx/most_frequently_ called_numbers |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the most frequently called number for an account. |
GET |
/analytics/{account_id}/topx/most_frequently_ called_destinations |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the most frequently called destinations for an account. |
GET |
/analytics/{account_id}/topx/most_frequently_ called_countries |
reportPeriodStart, reportPeriodEnd, parameter(num Results) |
Returns the most frequently called countries for an account. |
POST |
/analytics/{account_id}/summary/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (chartId) |
Creates a batch report schedule request for the Account Billing Overview report. |
POST |
/analytics/{account_id}/billing_trend/batchrpts |
reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Account Billing Trend report. |
POST |
/analytics/{account_id}/service_agreements/overview/batchrpts |
reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Service Billing Overview for all service agreements in the account report. |
POST |
/analytics/{account_id}/service_agreements/{service_number}/overview/batchrpts |
reportPeriodStart, reportPeriodEnd |
Creates a batch report schedule request for the Service Overview for a given service number. |
POST |
/analytics/{account_id}/service_agreements/{service_number}/details/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (usageType) |
Creates a batch report schedule request for the Service Details report. |
POST |
/analytics/{account_id}/topx/highest_spending _services/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for the Highest Spending Services report. |
POST |
/analytics/{account_id}/topx/most_expensive _calls/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for the Most Expensive Calls report. |
POST |
/analytics/{account_id}/topx/longest_calls/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for the Longest Calls report. |
POST |
/analytics/{account_id}/topx/most_frequently _called_numbers/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for the Most Frequently Called Numbers report. |
POST |
/analytics/{account_id}/topx/most_frequently _called_destinations/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for the Most Frequently Called Destinations report. |
POST |
/analytics/{account_id}/topx/most_frequently _called_countries/batchrpts |
reportPeriodStart, reportPeriodEnd, parameter (numResults) |
Creates a batch report schedule request for Most Frequently Called Countries report. |
GET |
/analytics/{account_id}/unbilledSummary |
None |
Returns an unbilled usage summary for an account. |
GET |
/analytics/{account_id}/unbilledSummaryBy Service |
None |
Returns an unbilled usage summary for an account by service |
GET |
/analytics/{account_id}/service_agreements/{service_number}/unbilledByPlan |
None |
Returns the unbilled usage plan for a service. |
GET |
/analytics/{account_id}/service_agreements/{service_number}/unbilledDetails |
parameter(TariffKey) |
Returns the unbilled usage transaction details for a tariff. |
GET |
/batchrpts/completed |
None |
Returns a list of completed batch reports that the user can access. |
GET |
/batchrpts/pending |
None |
Returns a list of pending batch reports that the user can access. |
GET |
/batchrpts/failed |
None |
Returns a list of failed batch reports that the user can access. |
GET |
/batchrpts/scheduled |
None |
Returns a list of scheduled batch reports that the user can access. |
GET |
/batchrpts/scheduled/{batrpt_id} |
None |
Returns a recurring batch report request that is scheduled. |
DELETE |
/batchrpts/scheduled/{batrpt_id} |
None |
Deletes a recurring batch report request that is scheduled. |
GET |
/batchrpts/{batrpt_id} |
None |
Returns a batch report request. |
DELETE |
/batchrpts/{batrpt_id} |
None |
Deletes a batch report. |
GET |
/batchrpts/content/{batrpt_id} |
None |
Returns batch report result content with pagination on. |
GET |
/batchrpts/download/csv/{batrpt_id} |
None |
Downloads a batch report in CSV file format. |
GET |
/batchrpts/download/xml/{batrpt_id} |
None |
Downloads a batch report in XML file format. |
GET |
/batchrpts/download/pdf/{batrpt_id} |
None |
Downloads a batch report in PDF file format. |