Gateway Traffic by Interval
This report groups API traffic in the selected environment by time interval and shows, for each interval, the number of successful, blocked, and error requests -- and their total -- along the time axis. It appears on the Metrics page under the Traffic tab as the "API Traffic By Interval" sub-report (Analytics > Reports > Metrics; in the Admin menu: Administration > Reports > 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.
For regular HTTP API Proxies, the traffic of a request is tracked across three separate measurement regions: request pipeline, routing, and response pipeline. WebSocket and gRPC connections do not go through these three phases; since they are continuous, bidirectional streams, they are only tracked as data coming into Apinizer and data going out of Apinizer. Because of this, these API Proxy types have only 2 measurement regions.
Filtering
The filter row at the top of the Metrics page is shared by all sub-reports and also applies to this report:
| Filter | Description |
|---|---|
| Environment | Selects the environment whose traffic you want to view. |
| Project | (Admin menu only) Filters traffic by one or more selected projects. |
| Date Range | Determines the time span over which traffic is collected. The default value is the last 1 hour. |
| Refresh | Reloads the sub-report currently shown on screen (in this case, API Traffic By Interval) with the current filter values. |
| Export (Excel) | The Excel icon on the sub-report pill row downloads the currently displayed report as an Excel file. |
Report-specific Controls
Three controls specific to this report sit on the sub-report button row and are only visible while this sub-report is selected:
| Control | Description |
|---|---|
| API Proxy | Narrows the report to specific API Proxies. Leave it empty to include every proxy. The option list is loaded according to the project selection in the filter row. |
| Interval | Determines the time buckets the traffic is grouped into. The report is re-queried as soon as you pick a value; you do not need to press Refresh as well. |
| Graph / List | Selects whether the same data is shown as a bar chart or as a table. Switching the view does not trigger a new query. |
Selectable interval values: Secondly, Minutely, Hourly, Daily, Weekly, Monthly, Quarterly, Annually. The default is Hourly.
Views: Graph and List
The report's data can be presented in two different forms.
Graph View
As shown in the screenshot above, three colored bars are displayed for each time interval:
- Green — Successful requests
- Orange — Blocked requests
- Red — Error requests
The X axis shows the start of the time interval, and the Y axis shows the number of requests in that interval.
List (Table) View
The same data can also be displayed as a table where each row represents one time interval.
Table Column Descriptions
| Column | Description |
|---|---|
| Interval Start Time | The start time of the time interval the traffic belongs to. |
| Success Request | Number of requests that completed successfully in this interval. |
| Blocked Request | Number of requests blocked in this interval, e.g. due to security policies or rate limiting. |
| Error Request | Number of requests that resulted in an error in this interval. |
| Total Request | Total number of requests in this interval (Success + Blocked + Error). |