Insights dashboard

Learn how to gain insights into performance issues, error occurrences, and usage patterns.

You may want to see how your endpoints are performing and you may want to know how many successful request have been made. You can get a quick overview of your endpoint's performance through the Insights Dashboard.

This dashboard is populated with live data from a published endpoint and updated dynamically. You can quickly see the key metrics of an endpoint through a visualization of an endpoint's request/response cycle over time. You can dig a bit deeper into your endpoint's performance with a more detailed summary.

Video Overview

View this video for an overview of using the Insights board for your Xapix project endpoints.

Accessing the Insights Dashboard

The Insights Dashboard is available only from within a project.

After selecting Insights from the Home menu in a project. the Insights Overview page is displayed. This give you an overview of the performance of all endpoints in your project. It gives you a summary of the key metrics of each endpoint.

Insights Overview page of a project

Clicking on one of the endpoints in the list displays a set of time series graphs and a summary of the endpoint performance.

Insights Dashboard for a selected endpoint

Number of requests per day

The Requests time series graph displays the number or requests made per day. The X-axis is date points beginning from the date the endpoint was created to the current date. The Y-axis is the number or requests made. Request performance is plotted on this graph where each point represents a summary of a day's number or requests. Hovering over a point displays this summary.

Requests graph for an endpoint

If you want to hide the graph, click the blue box beneath the graph.

Average duration of each request/response cycle

Using the same data as in the Requests graph, you can find out what was the average duration of all requests/responses on a specific day on the Avg. Duration (ms) time series graph. On this graph the X-axis is the day and the Y-axis is the average duration per day. Hovering over a point shows an exact number in ms.

Avg. Duration (ms) graph for an endpoint

If you want to hide the graph, click the blue box beneath the graph.

Endpoint Summary

A detailed summary of endpoint performance is provided in the Endpoint Summary table.

Endpoint Summary for a selected endpoint

The following table describes the information provided in the Endpoint Summary.

Information

Description

Plot

Slide to On to display the graphs. You can hide the graphs by setting the Plot slider to Off.

Name

Indicates which endpoint in your project these metrics are from.

Total Requests

Total number of requests made since the endpoint was published.

Avg. Duration

Average duration of the requests/responses. However, it may or may not reflect actual performance of the endpoint. The P95 duration may be a better metric for this.

Duration

Displays in a bar the duration of a request/response in comparison to other units.

P95 Duration

Displays the duration data values that are greater than or equal to 95 percent of the request/responses. This is actual user experience with the endpoint, which means 95. It is the latency of an endpoint which is the amount of time spent sending a request and receiving a response at a given duration.

Debug overview

On Insights page, apart from the performance summary, you also can find information about last requests to endpoint.

Debug Overview of last ten requests to endpoint

The Debug Overview window shows you the endpoint behavior for the last ten requests. It includes the following information:

  • Status of request

  • Timestamp of the request

  • Link to Debug dashboard with corresponding Correlation ID.

You can filter by All Requests or by Failed requests only.

The meaning of Failed depends on the following:

  • REST and SOAP endpoints - 500 status.

  • For Kafka and EventHub events - unexpected issue occurred due to pipeline execution and was terminated abnormally.