Check application API performance
Metered API calls come from applications that are not part of the SuperOffice standard products.
Count is the number of API calls. Record count is how many database records these API calls asked for. One database record could be asking for a company (with all additional entities, such as address, phones, URLs, and emails), and it may be one contact person with all additional entities linked to it. Asking for a list will count each list item as one database record.
At a glance
The API Performance tab shows API-level application performance for one specific application.
In the Developer Portal, go to your app page.
To see the list of all apps:
- Select Apps from the top menu, or
- Go to your partner overview page.
Select API metrics, then select API Performance tab.
Select a time range interval (minutes, hours, or days).
Click through the environment specific buttons.
Columns
| Type of usage | Description |
|---|---|
| Operation Name | The URL endpoint. |
| Count | The number of API invocations to the endpoint. |
| Record Count | The number of database records selected by the API invocation. |
| Duration (AVG) | The average number number of milliseconds elapsed for each of all API invocations. |
| Customer | The customer context identifier that invoked the API. |
Tip
Click on a row to observe the samples (individual invocations) related to the endpoint.
When there are many rows, you can filter the list by typing in the search box. The list will update as you type.
Filter by sample
To see the request details, select one of the samples from the samples list.
Use the sort option drop-down menu above the list to sort the samples according to timestamp, database rows, or duration.
Observe the sample details:
Note
The left side samples column contains each invocation for the endpoint. The center column contains the endpoint and the column on the right contains the invocation details.
To return to the API Performance list, click the X in the upper-right corner.
Improve app performance
Leverage our best practices for online app development to both boost your application's performance and reduce its API usage. Both caching and search have a huge impact.
During development, following the statistics in SOD day-by-day can provide valuable insight into the impact of your improvements.