Table 5. 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. |