Dashboard

View comprehensive usage data for your API Hub.

The Admin Panel's Dashboard tab provides a comprehensive view of usage in Enterprise Hub. It is divided into two main tabs - Overview and Traffic analytics.

Admin Panel's Dashboard tab

Admin Panel's Dashboard tab.

Overview tab

The Overview tab displays four sections: Governance, Billing, APIs and Hub. Use the 7d and 30d buttons on the upper right to show metrics trends over the last 7 or 30 days.

Governance

The Governance section of the Admin Panel's Dashboard tab.

The Governance section of the Admin Panel's Dashboard tab.

This section includes:

  • Users: The total number of users in the Enterprise Hub. The small number to the right indicates the number of new users within the selected period (or NA if there is no change). Click on the icon in the upper right to navigate to the Users tab of the Admin Panel.
  • Teams: The total number of teams in the Enterprise Hub. The small number to the right indicates the number of new teams within the selected period.
  • Subscribers: The total number of team and user subscriptions to all APIs in Enterprise Hub. Click on the icon in the upper right to navigate to the Subscriptions tab of the Admin Panel.
  • API Providers: The total number of teams and users that have added at least one API to the Hub. Click on the icon in the upper right to navigate to the Subscriptions tab of the Admin Panel, which shows details that includes a "Provider" column for API subscriptions.
  • Admins: The total number of Environment Admins in the Hub. These are users who have access to the Admin Panel.

Billing

The Billing section of the Admin Panel's Dashboard tab.

The Billing section of the Admin Panel's Dashboard tab.

This section only applies if you are monetizing APIs using Stripe on your Hub. It includes:

  • Gross Volume: The estimated monetary amount (usually in US dollars) of all successful payments made by API consumers, including payments that are refunded or disputed. Click on the link in the upper right to navigate to the Admin Panel's Transactions tab.

  • Net Volume: The estimated monetary amount (usually in US dollars) of payments made by API consumers minus refunds and disputes. This number does not include Stripe's fees.

  • Successful Payments: The total number of successful payments made by API consumers. This number includes payments that are refunded or disputed.

APIs

This section includes:

The APIs section of the Admin Panel's Dashboard tab.

The APIs section of the Admin Panel's Dashboard tab.

  • Total API Traffic: The total count of all API calls made by API consumers. This includes calls made through the Rapid Runtime, or calls imported using the Platform Analytics API. This helps monitor the trends of API traffic and identify potential threats, such as spikes that could indicate misuse or attacks, or drops that could indicate technical issues. Click on the link in the upper right to go to the Admin Panel's APIs tab.

  • Active API Consumers: The number of teams or users who made at least one API call within the selected period. This can provide insights into the level of engagement of an API and help inform decisions related to capacity planning, resource allocation, and product development.

  • Total Errors: The count of API requests that returned an error code within the selected period. This helps detect potential issues or risks. To see more information about the errors, click on the link in the upper right to navigate to the Traffic analytics tab. This allows you to to see a more detailed breakdown of when the errors happened. For details related to a specific API, use the Analytics and usage tab for the API.

  • Spike Arrests: The count of all API calls that responded with the error code 429 (Too Many Requests). This is important in monitoring spikes in API traffic and detecting potential security threats. To see more information about the errors, click on the Traffic analytics tab.

  • Highest Traffic APIs: The five APIs with the highest amount of API calls made during the selected period. This can help organizations identify potential traffic spikes and proactively address them to ensure their APIs remain available and responsive. To view more analytics for a specific API, click the API's name to be brought to the API's Analytics and usage tab for the API. The label under the API name indicates the API's Category. The top number on the right indicates the total number of call made to the API for the selected period. The number under that indicates the percentage of increase or decrease in API calls compared to the previous period.

  • API Traffic: This is the chart displaying the total number of daily API calls for the selected period. Monitoring API traffic on a daily line chart can provide valuable insights into the usage patterns of your APIs. By tracking daily traffic, organizations can identify trends and make informed decisions about capacity planning and resource allocation. If you are looking for a lower time resolution (hours/minutes), navigate to the Traffic analytics tab.

  • Most Popular APIs: The five APIs with the highest number of teams or users that made at least one call to the API during the selected period. To view more analytics for a specific API, click the API's name to be brought to the API's Analytics and usage tab for the API. The label under the API name indicates the API's Category. The top number on the right indicates the total number of unique users or teams that made calls to the API for the selected period. The number under that indicates the percentage of increase or decrease in unique users or teams compared to the previous period.

  • Highest Error APIs: The five APIs with the highest error rate. This can be used to pinpoint areas for improvement. To view more analytics for a specific API, click the API's name to be brought to the API's Analytics and usage tab for the API. The label under the API name indicates the API's Category. The top number on the right indicates the total number of calls made to the API over the selected period that resulted in an error response. The number under that indicates the percentage of increase or decrease in calls that resulted in errors compared to the previous period.

  • Most Active Consumers: The five users or teams making the highest number of API calls across all apps owned by the user or team. This can reveal partnership opportunities and provide customer insights. Click the user or team name to view more information about the user or team. Clicking on a user name navigates you to the user in the Users tab of the Admin Panel. Clicking on a team name navigates you to the Organizations tab of the Admin Panel. The organization that contains the team is displayed. Click the Teams tab to view details about the team.

    The top number on the right in the Most Active Consumers section indicates the total number of call made by the team or user for the selected period. The number under that indicates the percentage of increase or decrease in API calls compared to the previous period.

Hub

The Hub section of the Admin Panel's Dashboard tab.

The Hub section of the Admin Panel's Dashboard tab.

This section includes:

  • Public APIs: The total number of public APIs on the Enterprise Hub. Public APIs are discoverable by any use logged into the Enterprise Hub.
  • Private APIs: The total number of private APIs on the Enterprise Hub. Private APIs are discoverable only by the user or team that owns the API, or by entities (users, teams, organizations) that have been invited to consume the API.

Traffic analytics tab

The Traffic analytics tab of the Dashboard contains a near-real-time chart (up to a five min delay) that can be used to analyze your overall API traffic load, error rate, and latency. Based on the time periods you want to show, different resolutions can be used.

For each of those dimensions, you can replace the aggregation function to show the average, median, max, min, or total. Do this by opening the dropdown near the dimension for which you would like to change the aggregation function.

1649

Traffic analytics tab of the Admin Panel's dashboard

In addition, you can change the line chart to display any of the dimensions by clicking that tab.

1635

Viewing the Average Error Rate in the Admin Panel's dashboard

On the top left of the chart, you will find the API filter, which can be used to scope your search to a specific set of APIs.