Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Here you can track the utilization of your application and see if there are increased errors.

ApplicationDetailsAnalytics-20231205-101438.pngImage Removed

Overview

The " Analytics " page is a component of an API management platform, focusing on the performance and usage metrics of an application, in this case, the "Car Finder" application. The analytics displayed provide insights into the application's interactions with APIs.

Interface Sections

  • General: This left-hand panel provides a navigation menu that allows users to move between different aspects of the application's management interface.

  • Date and Gateway Selector: Located at the top right, users can select the date range for the data they wish to analyze and the gateway from which to pull the data.

Graphical Representations

  • Hits by Response Codes: A donut chart categorizes the hits the application has received based on HTTP response codes. The color coding (e.g., green for 200, purple for 400, orange for 403, red for 500) provides a quick visual assessment of the overall health and success rates of API calls.

  • Hits over Time: A line graph shows the number of hits over time, with different colors representing different response codes. This allows users to track the application's API call patterns and identify any unusual spikes or drops in traffic.

  • Latency over Time: This chart displays the application's response latency over time. The bars in the background provide a range for the minimum and maximum latency observed, while the line indicates the average latency. This metric is crucial for understanding the performance of the application.

Interface Features

  • Reload Button: To refresh the data displayed, accommodating real-time monitoring or after changing the selected gateway or date range.

  • Graph Data Points: Hovering over the graphs typically displays precise data for specific times or categories.

  • Drop-Down Menus: These allow for the customization of the data displayed, whether by changing the time frame or by selecting a different API gateway

    dashboard is carefully arranged to present crucial metrics and data visualizations that detail the Applications’ performance metrics.

    apiida37.pngImage Added

    Hits by Response Codes

    On the upper left side of the analytics dashboard, there's a donut chart labeled "Hits by Response Codes." This visual tool displays the volume of API hits according to the HTTP response status codes they generated. Each segment is color-coded, corresponding to a different response code—200 (green), 400 (orange), 403 (orange), and 500 (purple)—allowing users to gauge at a glance the proportion of successful requests versus different classes of client and server errors.

    Hits Over Time

    Adjacent to the donut chart is a line graph titled "Hits over time". This graph offers a temporal view, plotting the count of API hits over the course of a single day, broken down by hour. Each line represents a different response code, color-matched to the segments in the donut chart. This allows for a detailed analysis of traffic patterns and potential response issues as they fluctuate throughout the day.

    Latency Over Time

    Below the "Hits over time" graph, there is another chart focusing on "Latency over time" measured in milliseconds (ms). It employs a bar-and-line hybrid style to communicate two key pieces of information: the average latency is represented by the line graph, while the range between minimum and maximum latencies for given times is depicted by the shaded bars. This dual representation provides a clear visualization of both the average performance and the volatility of response times.

    Table of contents

    Table of Contents
    minLevel1
    maxLevel6
    outlinefalse
    stylenonedisc
    typelist
    printablefalse