When an API behaves unexpectedly — high error rates, latency spikes, or unusual traffic — DataService Studio monitoring charts give you the visibility to pinpoint the cause. On the Statistics Details page, you can track HTTPS status codes, DataService Studio error codes, application request counts, traffic and bandwidth, and response time across API Gateway, DataService Studio, and the data source.
Prerequisites
Before you begin, make sure you have:
A DataWorks workspace with DataService Studio enabled
At least one API published in DataService Studio
Open the monitoring charts for an API
Log on to the DataWorks console. In the top navigation bar, select a region. In the left-side navigation pane, choose Data Analysis and Service > DataService Studio. Select a workspace from the drop-down list and click Go to DataService Studio.
In the top navigation bar, click the Service Management tab. The Manage APIs page appears.
In the left-side navigation pane, choose API Statistics > Statistics Details.
Find the API you want to monitor and click Monitoring Chart in the Actions column.
Monitoring charts
The Statistics Details page provides the following charts. Each chart shows change trends over a selected time period.
| Chart | What it measures |
|---|---|
| HTTPS Status Codes | Count of API responses by HTTP status code type |
| DataService Studio Error Codes | Count of API responses by DataService Studio error code type |
| Number of Application Requests | Number of times each application called the API |
| Traffic Bandwidth | Outbound traffic from DataService Studio and API Gateway after the API is called |
| Response Time | Response time across API Gateway, DataService Studio, and the data source |
HTTPS Status Codes
Tracks how many responses of each HTTP status code type the API returned. Use this chart to spot error spikes — for example, a surge in 5xx codes may indicate a backend issue.
DataService Studio Error Codes
Tracks how many responses of each DataService Studio error code type the API returned. Use this chart to identify and troubleshoot DataService Studio-level errors. For error code definitions, see Appendix: DataService Studio error codes.
Number of Application Requests
Tracks how many times each application called the API. Use this chart to identify which applications are the heaviest consumers.
Traffic Bandwidth
Tracks outbound traffic from both DataService Studio and API Gateway after the API is called. Use this chart to monitor bandwidth usage trends.
Response Time
Tracks response time across three layers after the API is called: API Gateway, DataService Studio, and the data source. The three measurements are nested — API Gateway response time includes DataService Studio response time, which in turn includes data source response time.
| Layer | What it measures |
|---|---|
| API Gateway | End-to-end response time from the client's perspective — the broadest measure |
| DataService Studio | Processing time within DataService Studio, contained within API Gateway time |
| Data source | Query execution time at the data source, contained within DataService Studio time |
When response time is abnormally high, compare the three layers to pinpoint where the latency originates.