View REST & SOAP API analytics

View overall API analytics, analytics per API, or analytics per requesting user in the REST & SOAP API Analytics dashboard.

Before you begin

Role required: api_analytics_read, web_service_admin, or admin

About this task

The REST & SOAP API Analytics dashboard contains Usage Overview, Usage by API, and Usage by Requestor analytics. From the Usage by API and Usage by Requestor tabs, you can filter by API and requestor get more specific insights.

[Omitted image “analytics-usage-overview.png”] Alt text: Usage Overview tab of the REST & SOAP API Analytics dashboard.

Procedure

1. Navigate to All > System Web Services > Analytics Usage Overview to open the REST & SOAP API Analytics dashboard.

   Tip: You can also access the dashboard from the context menu in the REST API Explorer or from the API analytics related link in custom web services forms.

2. Select one of the following tabs in the dashboard.

Option Action **Usage Overview** View general usage statistics for all REST and SOAP APIs. **Usage by API** View detailed usage statistics for each API. 1. From the **API Stats by API** menu, select one or more APIs. 2. Move the selected APIs to the **Applied** list. 3. Select **Apply**. **Usage by Requestor** View detailed usage statistics for each requesting user. 1. Specify the API requestor analytics to view. 1. From the **API Stats by Requestor** menu, select one or more requestors. 2. Move the selected requestors to the **Applied** list. 3. Select **Apply**. 2. Specify the API analytics to view. 1. From the **API Stats by API** menu, select one or more APIs. 2. Move the selected APIs to the **Applied** list. 3. Select **Apply**. If the selected user has not made requests to the selected API, no data is shown for that combination.

Parent Topic:Analyze REST and SOAP API usage

Related topics

Use the REST API Explorer

Dashboards in Platform Analytics