Traffic, Latency and Errors Report

The
Traffic, Latency & Errors
report shows traffic, response latency, and error rate trends of APIs, organizations, and applications over a period. You can further compare current metrics with historical data and understand the corresponding trends.
From the menu bar, select
Monitor,
Traffic, Latency & Errors
to access this report.
By default, all the selections you make in the filters are saved and you can view the reports with these selections the next time you access the reports.
Click
Export
at the top-right corner to export the trend charts.
Data Source Filters
Data source filters are displayed based on your access permissions. If you have access to only one entity like an API or an organization, the filter is automatically set. When you do not apply any filter, you see the overall traffic for the tenant.
You can filter the data sources based on the following entities. These filters are stackable:
  • APIs
  • Applications
  • Organizations
Org Publishers can view and select any organization and filter data across all organizations of the tenant. They can also view and select applications that consume the APIs owned by their organization.
Default filter:
Top 3 APIs, Last 7 Days
You can further sort each entity by either of the following:
  • Rank:
    Use this option to sort the top-ranking entities.
  • Name:
    Use this option to sort based on the entity name.
Click the filter to see these options as shown in the following image:
Rank Name Filter
You can visualize up to
10
data slots for the entities to achieve the possible combinations. This limit is cumulative across all the selected filters. The
data slots remaining
label shows how many more entities you can choose to add.
Example:
Following are some examples to understand the data source filters:
  • As the filters are stackable, if you select
    Top 3 APIs
    and
    Top 2 Apps
    , it means that the report would include data for the top two applications within the top three APIs with six lines in the graph.
  • If you select
    3
    in
    Rank
    for the
    API Filter
    , it means that the top three APIs with the highest ranking are included in the
    APIs
    filter.
Date Range Filters
Select a custom time period to see specific reports. Click
Edit
under the
Date Range
section to see the options. You can select current timelines, select a time interval starting now and going back by the stated number of days, or select a date range. You can select a maximum of five years in the date range filter.
Default filter:
Last 7 days
Data is rolled up and plotted in the graph based on the following time intervals:
  • Last 1 Hour
    : (if supported) The data is plotted by minute.
  • Last 24 Hours
    : (if supported) The data is plotted by hour.
  • Last 7 Days
    : The data is plotted by day.
  • Custom Date Range:
    • Up to 2 days, the data is plotted by hour.
    • 3 days to 60 days, the data is plotted by day.
    • 61 days to 1 year, the data is plotted by week.
    • Beyond 1 year, the data is plotted by month.
Graphs and Metrics
Each report panel has a graph and a Metrics section, which shows the data. You can view the details corresponding to any data point by hovering over the data point in the graph; all the relevant details are included in the pop-up:
  • X-axis:
    Displays the date and timezone based on your selected date range.
  • Y-axis:
    Displays X interval margin around the minimum/maximum of the lines that are plotted.
The Metrics section in the Traffic, Latency, and Errors report shows the aggregated data based on the filters that you selected. Click a metric to add or remove the corresponding line from the graph. The subtitle text under the
Metrics
heading shows the number of lines on the graph and the overall limit.
The key metric is the first datapoint to be listed in the Metrics section. The other datapoints are historical datapoints that you can use to compare with the current metrics. The key metric is always visible if one of the historical lines is toggled on.
Traffic
This graph shows the traffic trends of the selected APIs, applications, and organizations in the selected time period:
  • Key Metric:
    Total API Hits
  • Historical Data:
    30 Days Ago, 52 Weeks Ago
Latency
This graph shows the average, minimum, and maximum latency trends of the selected APIs, applications, and organizations in the selected time period. Latency is plotted only for successful API requests:
  • Key Metric:
    Average Latency
  • Other Metrics:
    Maximum Latency, Minimum Latency
  • Historical Data:
    30 Days Ago, 52 Weeks Ago
Errors
This graph shows the error percentage for the API hits of the selected APIs, applications, and organizations in the selected time period. All API requests that return HTTP error responses are categorized as errors:
  • Key Metric:
    Error Rate
  • Historical Data:
    30 Days Ago, 52 Weeks Ago