Consolidated API Usage

The Consolidated API Usage report shows the number of requests and corresponding outcomes for each API in each application for the selected range of dates.

In addition to the use of report filters, Nuance Insights allows you to manipulate displayed data through several other means in order to better visualize information. Select from the following to learn more:

Note: This report is applicable only for clients using the Conversational AI channel.

Column Description
Web App Web application
API API command name, such as startSession, speechRecognition, and so on
Outcome Result status indicator
Total Requests Total number of requests for this combination of dimensions

Visualizations

The API/Outcome histogram graphically represents the request number by outcome for each API (differentiated with color-coding) and grouped by application. The Consolidated API Usage table immediately following the histogram is a 1:1 representation of the same data, grouping by API. The Consolidated API Usage Details table at the bottom of the page draws from the same data set but groups the information by date stamp.

Mouse over any of the histogram bars to display a tool tip listing the underlying data for that particular response code.

Filters

Time Range

The Time Range slider allows you to narrow or expand the date range. The data displayed in all visualizations automatically reflect the subset of information falling within the selected range.

Tenant

By choosing one or more tenants from the list, you refine your displayed data-set by including data from only those tenants matching the selection. The visualizations automatically reflect the information complying with the tenant selection.