API Usage Metrics in Solution Provider Portal

The API usage dashboard in Solution Provider Portal helps you monitor performance across your registered applications. Use the dashboard to:

• Track error rates: Monitor client error percentages to identify potential issues with your API implementations.
• Analyze call patterns: Review call volume trends to understand usage patterns.
• Identify problem operations: Use the detailed breakdown to pinpoint specific API operations that might need attention.

You can view metrics at the account level, filter by application, and filter by time frame.

⚠️

Note

Dashboard data is refreshed daily and shows the last update timestamp at the top of the page.

Accessing the API usage dashboard

Within Solution Provider Portal, you can access the API usage dashboard in two ways:

• From the main page: In the featured functions section, choose Manage API calls.

• From the navigation menu: Choose Apps, and then choose API Usage Dashboard.

Filtering data

To customize the data that your dashboard displays, use the following filters:

• Application filter: Choose All Apps to view data for all applications or select a specific application from the dropdown.
• Time frame filter: Choose your desired time period, such as This month, for the data display.

Available metrics

You can view account-level metrics or filter by application.

Account-level summary

The account-level summary gives an overview of your account's performance metrics, such as:

• Apps - Number of applications registered in your account
• Call volume - Total number of API calls across all applications
• Successful calls - Number of successful API calls
• Successful call rate - Percentage of successful calls
• Client errors - Number of client error responses
• Client error rate - Percentage of client error responses

Application-level details

For each registered application, the API usage dashboard shows a detailed breakdown table that includes the following information:

• Section - API section names (such as fba, dataKiosk, feeds, orders)
• Operation - Specific API endpoints and operations
• Call Volume - Total number of calls for each operation
• HTTP Status Codes - Breakdown of response codes that include:
  • Successful calls (200, 201, 202, and 204)
  • Client errors (400, 403, 404, and 429)
  • Server errors (500)