Default dashboards
IBM® API Connect analytics provides some preconfigured dashboards for you to use to view common analytics data.
A list of dashboards is displayed when you open the default dashboards page for the first
time. These dashboards provide examples of the data that you can view by using the analytics
dashboards. You can use these dashboards as they are, or clone them to customize them to your needs.
You cannot modify the existing dashboards. After you have cloned or created some of your own
dashboards, your dashboards also appear in this list.
The following dashboards are provided with
API Connect:
- API Default
- Includes general information about your APIs. This is the equivalent dashboard that was provided
as api_default in API Connect Version 5. It
includes the following visualizations:
- Status Codes (detailed)
- Lists the detailed status codes of the API requests.
- Errors
- Displays the number of errors in a bar graph.
- Minimum Response Time (ms)
- Lists the fastest response time of the APIs in milliseconds.
- Average response time (ms)
- Lists the average response time across all of the APIs in milliseconds.
- Maximum Response Time (ms)
- Lists the maximum response time of the APIs in milliseconds.
- Response Times (ms)
- Provides a complete list of the response times of the API calls in milliseconds.
- API calls
- Provides a list of the API calls.
- API Calls per day
- Provides a graphical representation of the number of API calls that occurred each day.
- Catalog Default
- Includes general information about the most used Products in your Catalog. This is the
equivalent dashboard for catalog_default in API Connect Version 5. It
includes the following visualizations:
- Top 5 Products Overall (Daily Usage)
- Displays a graph of your 5 Products that receive the most calls on a daily basis.
- Top 5 APIs Overall (Daily Usage)
- Displays a graph of your 5 APIs that receive the most calls on a daily basis.
- Monitoring Latency
- Provides information about the amount of time that elapses after the API request is submitted
and the transfer of data begins. It contains the following visualizations:
- Response Times (ms)
- Provides a complete list of the response times of the API calls in milliseconds.
- Response times (>1 sec)
- Displays the calls where the response times are greater than 1 second. Note: This visualization runs a search that limits the results to the last 500 calls.
- Average response time (ms)
- Lists the average response time across all of the APIs in milliseconds.
- Data Usage (bytes received)
- Lists the bytes of data that are received to complete your calls.
- Data Usage (bytes sent)
- Lists the bytes of data that are sent to complete your calls.
- Maximum Response Time (ms)
- Lists the maximum response time of the APIs in milliseconds.
- Monitoring Status
- Provides information about monitoring the status of your API. This dashboard includes the
following visualizations:
- Success Rate
- Displays how many of your API calls were successful, compared to how many were submitted.
- Status Codes (simple)
- Provides overview status codes for the API calls.
- API calls
- Provides a list of the API calls.
- Errors
- Displays the number of errors in a bar graph.
- Successes
- Lists the successful API calls.Note: This visualization runs a search that limits the results to the last 500 calls.
- Portal Default
- Provides information about the API requests to APIs in the Developer Portal. This is a
replication of the portal_default dashboard in API Connect Version 5. This
dashboard includes the following visualizations:
- Success Rate
- Displays how many of your API calls were successful, compared to how many were submitted.
- Data Usage (bytes sent)
- Lists the bytes of data that are sent to complete your calls.
- Response Times (ms)
- Provides a complete list of the response times of the API calls in milliseconds.
- Product Default
- Provides information about the Products. This is a replication of the
product_default dashboard in API Connect Version 5. This
dashboard includes the following visualizations:
- Developer Organizations
- Lists the numerical value of the number of existing developer organizations.
- Apps per Plan
- Displays a pie chart with the number of subscriptions to each Plan.
- API Calls per day
- Provides a graphical representation of the number of API calls that occurred each day.
- API calls
- Provides a list of the API calls.
- API Calls per day
- Provides a graphical representation of the number of API calls that occurred each day.