For the complete documentation index, see llms.txt. This page is also available as Markdown.

Insights

The insights page allows you to view various data concerning your usage of the Mindee platform and API.

Overview

Use the insights page to view all of your requests over a given period.

Notably, you can keep track of your credit usage.

Access the Insights Page

  1. On the left-hand menu, click on Insights

Or simply click here: Go to Insights page

Data Views

Selecting the Data View is done at the top of the page:

Insights - data view selector

All Data Views will show the total usage, at the bottom of the page:

Traffic View

The Traffic view shows the number of calls and the number of pages that were successfully processed.

These requests count towards your plan's credit usage, the number of credits consumed is shown.

This does not include calls that resulted in an error.

insights - traffic shows requests, pages, credits

Processing Time View

The Processing Time view shows the average time requests take to process, in seconds.

Processing time is calculated from when the request was received to when the inference was finished.

insights - processing time

Errors View

The Errors view shows the number of processing (inference) errors.

This does not include user errors (HTTP 4xx), since these requests get rejected before any processing takes place.

Errors are shown for informational purposes only, they do not count towards your plan's credit usage.

insights - errors

Data Filters

For all data views, the following filters are available.

Origin Filter

Filter based on the origin of the request.

Insights - filter data based on origin

"Live Test" is when using the live test functionality on the platform.

"API" is for any request made using an API key.

Date Range Filter

Filter based on start and end dates.

Group By

Only affects the visualization. Group results by day, month, or year.

API Key Filter

Show all API keys or filter on a specific one.

Activated Options

Filter by optional features activated in the call.

3 states to choose from:

  • empty: no filter

  • check mark: show only calls with the option active

  • minus sign: show only calls with the option inactive

Last updated

Was this helpful?