IP Traffic & Time Metrics
Since an API Proxy can be loaded into multiple environments, metrics must also be evaluated according to the environment it is loaded into. Therefore, in all analytics screens, metrics are filtered by first selecting environment information.
Metric data cannot be displayed for environments where Elasticsearch integration is not configured. In this case, a warning message is displayed on the screen.
Metrics Page
This report is the IP Traffic Metrics sub-report on the Clients tab of the Metrics page (documented as IP Traffic & Time Metrics). Open it via Administration > Reports > Metrics or Analytic > Reports > Metrics in the project menu, then select IP Traffic Metrics on the Clients tab.
The table is a three-level tree keyed by IP; expand an IP row to see API Proxies it used and drill down to method/endpoint breakdown.
Filtering
The filter row at the top of the Metrics page is shared across all tabs and sub-reports:
| Option | Description |
|---|---|
| Environment | Select the environment whose metrics you want to view |
| Project | (Administration only) Filter metrics by selecting multiple projects |
| Date Range | Time range for metric calculation (default: last 1 hour) |
| Refresh | Re-queries the currently displayed sub-report |
| Excel Export | Export on the shared filter row; downloads the list for the active sub-report |
Report-specific filters
Visible on the sub-report row only while IP Traffic Metrics is selected:
| Option | Description |
|---|---|
| IP Address | Limit results to a specific IP address |
| Proxy | Limit results to selected API Proxies |
The sub-report row includes Choose Your Refresh Time (default: Manual) and a refresh button.
Table Column Descriptions
The table is a tree structure keyed by IP address: the arrow icon on the left of each row expands/collapses one level below it.
- Level 1 (root row): An IP address that generated traffic.
- Level 2: An API Proxy that IP address sent requests to.
- Level 3 (deepest level): An endpoint (method/endpoint) under that API Proxy that the IP called.
The columns are grouped into six sections.
Information
| Column | Description |
|---|---|
| IP Address | Client IP at the root row; API Proxy name or method/endpoint path at lower levels |
| Project | (Administration only) Project name on API Proxy rows; blank on the IP root row |
Traffic Metrics (count)
Number of requests, for the node (IP / API Proxy / endpoint) on that row, in the selected environment and date range, by result:
| Column | Description |
|---|---|
| Successful | Number of requests resulting in a successful response |
| Blocked | Number of requests blocked by policies (e.g., security, rate limiting) |
| Error | Number of requests resulting in an error |
| Total | Sum of Successful + Blocked + Error |
Request Pipeline Time (ms)
Processing time of the request policies the request passes through after reaching the gateway and before being routed to the backend:
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Routing Time (ms)
Time elapsed from sending the request to the backend until the response is received back (backend round-trip time):
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Response Pipeline Time (ms)
Processing time of the response policies the response coming back from the backend passes through before being delivered to the client:
| Column | Description |
|---|---|
| Min. | Shortest time measured in this segment (ms) |
| Max. | Longest time measured in this segment (ms) |
| Avg. | Average time measured in this segment (ms) |
Total Time (ms)
Sum of Request Pipeline + Routing + Response Pipeline times; the total time from the request reaching the gateway until the response is returned to the client:
| Column | Description |
|---|---|
| Min. | Shortest total time measured for this node (ms) |
| Max. | Longest total time measured for this node (ms) |
| Avg. | Average total time measured for this node (ms) |