Gateway 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 API Traffic Metrics sub-report on the Traffic tab of the Metrics page (documented as Gateway Traffic Metrics). Open it via Administration > Reports > Metrics or Analytic > Reports > Metrics in the project menu.
The top row includes Traffic, Endpoints, Clients, Canary & Mirror, Growth, and (Administration only) Conflicts tabs. The Traffic tab has two sub-reports: API Traffic Metrics (this page) and API Traffic By Interval.
Filtering
The filter row at the top of the Metrics page is shared across all tabs and sub-reports:
| Option | Description |
|---|---|
| Environment Selection | You can select the environment you want to see metrics for |
| Project Selection | (Only in the Admin menu) You can filter metrics by selecting multiple projects |
| Date Range | You can determine the time range you want to see your metrics for (default: last 1 hour) |
| Refresh | Instantly re-queries and updates the currently displayed sub-report |
| Excel Export | Export on the shared filter row; downloads the list for the active sub-report |
The sub-report row includes Choose Your Refresh Time (default: Manual) and a refresh button; only the selected sub-report is affected.
Table Column Descriptions
The columns are grouped into six sections; each row represents one API Proxy.
Information
| Column | Description |
|---|---|
| Project | Name of the project the API Proxy belongs to (only visible in the Admin menu) |
| API Proxy | Name of the API Proxy |
Traffic Metrics (count)
The number of requests made to the API Proxy in the selected environment and date range, broken down by result:
| Column | Description |
|---|---|
| Successful | Number of requests that completed successfully |
| Blocked | Number of requests blocked by policies (e.g. security, rate limiting) |
| Error | Number of requests that resulted in an error |
| Total | Successful + Blocked + Error request count |
Request Pipeline Time (ms)
The 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 region (ms) |
| Max. | Longest time measured in this region (ms) |
| Avg. | Average time measured in this region (ms) |
Routing Time (ms)
The time elapsed while the request is sent to the backend and the response is received back (backend round-trip time):
| Column | Description |
|---|---|
| Min. | Shortest time measured in this region (ms) |
| Max. | Longest time measured in this region (ms) |
| Avg. | Average time measured in this region (ms) |
Response Pipeline Time (ms)
The 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 region (ms) |
| Max. | Longest time measured in this region (ms) |
| Avg. | Average time measured in this region (ms) |
Total Time (ms)
The sum of Request Pipeline + Routing + Response Pipeline times; the total time elapsed from the request reaching the gateway to the response returning to the client:
| Column | Description |
|---|---|
| Min. | Shortest total time measured for this API Proxy (ms) |
| Max. | Longest total time measured for this API Proxy (ms) |
| Avg. | Average total time measured for this API Proxy (ms) |