The metering dashboard in DataService Studio gives you a real-time view of API call activity across your workspace — total call volume, error distributions, resource trends, and which APIs are generating the most traffic or errors.
Open the metering dashboard
-
Log on to the DataWorks console. In the top navigation bar, select the target region. In the left-side navigation pane, choose Data Analysis and Service > DataService Studio. Select the workspace from the drop-down list and click Go to DataService Studio.
-
At the top of the page, click Service Management. The API Management page appears by default.
-
In the left navigation pane, click API Metering > Metering Dashboard.
View overall metrics
The top of the dashboard shows three metrics for your workspace:
-
Total number of APIs — the total count of APIs in the workspace to date, including both published and unpublished APIs.
-
Overall metrics — the total number of calls and total execution duration for all APIs over a selected period. The statistical period is up to 7 days.
-
API Gateway status code distribution — a pie chart showing how API Gateway status codes are distributed across all published APIs over a selected period (up to 7 days). Status codes fall into three categories: 2xx (success), 4xx (client errors), and 5xx (server errors). Click a colored segment to filter the view for a specific status code. For a full list of status codes, see Error code table.
-
DataService error code distribution — a pie chart showing DataService error codes returned by all APIs over a selected period (up to 7 days). Click a colored segment to view details for a specific error code. For error code definitions, see Appendix: DataService error code table.
View service resource allocation for the last 24 hours
The service resource allocation chart shows the trend of API calls over the last 24 hours. Use this chart to spot sudden spikes or drops in call volume.
View leaderboards
The leaderboards surface the top 10 APIs or apps by error rate and call volume, based on data from the last 24 hours.
Top 10 APIs by error rate yesterday
Shows the top 10 APIs with the highest call error rates in the last 24 hours.
| Column | Description |
|---|---|
| API ID | Unique identifier of the API |
| API name | Name of the API |
| Number of requests | Total requests in the last 24 hours |
| Failure rate | Percentage of failed requests |
| DataService resource group | Resource group the API belongs to |
Top 10 by call volume yesterday
Shows the top 10 APIs or apps with the highest call volume in the last 24 hours. Use the button in the upper-right corner to switch between the API dimension and the App dimension.
| Column | API dimension | App dimension |
|---|---|---|
| ID | API ID | App ID |
| Name | API name | App name |
| Workspace | — | Workspace name |
| Number of requests | Yes | Yes |
| Execution duration | Yes | Yes |
| Average call duration | Yes | Yes |