• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

Check application usage (API calls)

•
Environment: cloud
•
Version: 1.16
Some tooltip text!
• 3 minutes to read
 • 3 minutes to read

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 app page shows application usage for one specific application.

  1. 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.
  1. Select API metrics, then select API Usage tab.

  2. Select a time range interval (days, weeks, or months).

  3. Click through the environment specific buttons.

API usage overview in SuperOffice developer portal -screenshot

Legend

Type of usage Description
MeteredApps The number of API calls this app does for custom and standard apps.
Customizations The number of API calls from CRMScripts or screens that are custom (non-standard Service functionality)
IncludedApps The number of API calls from SuperOffice's own apps with Exclude from invoice. Standard functionality
Tip

Click on the individual items in the legend to filter what is shown in the graph.

API usage filtering -screenshot

Filter by customer

  • To see the impact of your app on one specific customer (tenant), select a customer from the drop-down list.

    Note

    The list contains only the customers that have authorized the app for a specific environment. For example, a SOD tenant appears only in the SOD environment. If you don't see a customer you think should be in the list, check that you have selected the correct environment.

  • To clear the filter, click the red cross.

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.

The default time period when you look at API calls is Months, but you can change the resolution on the horizontal axis to Weeks or Days.

API usage per week -screenshot

API usage per day -screenshot

During development, following the statistics in SOD day-by-day can provide valuable insight into the impact of your improvements.

© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top