Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.
  • Madrid
  • London
  • Kingston
  • Jakarta
  • Istanbul
  • Helsinki
  • Geneva
  • Store

REST & SOAP API analytics dashboards

Log in to subscribe to topics and get notified when content changes.

REST & SOAP API analytics dashboards

You can view API analytics for the entire instance or for specific APIs using the included dashboards.

REST & SOAP API Analytics includes dashboards that present the overall analytics, analytics per API, and analytics per requesting user.

To access API Analytics dashboards, navigate to System Web Services and select Usage Overview, Usage by API, or Usage by Requestor. Users with the api_analytics_read or admin roles can view these dashboards.
Note: The Usage by Requestor dashboard uses the Responsive Canvas feature available with Istanbul. For the best experience on upgraded instances, you may need to enable responsive dashboards.
The following dashboards are available:
Table 1. Available API analytics dashboards
Dashboard Description
Usage Overview Provides general usage statistics for all REST and SOAP APIs.
Usage by Web API Provides detailed usage statistics for each API.
Usage by Requestor Provides detailed usage statistics for each requesting user.

You can additionally filter by API to view detailed stats for a specific user and API combination. If the selected user has not made requests to the selected API, no data is shown for that combination.

Note: To view API stats for all users, do not clear the user breakdown selection. Instead, use the Usage by Web API dashboard.

You can access API analytics from the REST API Explorer. When exploring an API, click the context menu icon () then select API analytics to view analytics for that specific API.

For custom web services, such as scripted REST APIs or scripted SOAP web services, you can access analytics for the API by clicking the API analytics related link on the Scripted REST Service or Scripted Web Service forms.

When you directly access the analytics for an API, if there are no analytics for that specific API, the analytics for all APIs appears.