Monitoring API usage

This page describes the way you can monitor your licenses and API usage within Integration Service.

Checking license allocation

Organization licenses

To view organization-wide license distribution, log in to Automation Cloud^TM and go to Admin > Your Organization > Licenses.

The Licenses dashboard shows the number of all purchased licenses in your organization. You can switch to the Consumables tab to view license information for Integration Services, displayed as Integration Service API calls.

License types

Hover over the progress bar to see the number of allocated licenses out of the total number of purchased licenses in your organization.

Bundled with license: Represents the API calls bundled with the User, Bot and Automation Express licenses your organization has licensed. The API calls allocated on this plan expire by the end of every month and reset on the 1st of the next month.
- Enterprise license: along with API Calls allocated for User and Bot, this pool includes the additional 100K API calls allocated from the Automation Express license.
- Pro and ProTrial licenses: along with API Calls allocated for User and Bot, this pool includes the additional 25K API calls allocated from the Automation Express license.
- Free license: The pool includes the 0-25K API calls allocated from the Automation Express license.
Dedicated Bundle: Represents the Platform SKU your organization has licensed. The API Calls allocated on your plan are from licensing one of the below Platform Individual SKUs:
- UiPath - Flex - Integration Service API Calls Bundle - 3M
- UiPath - Flex - Integration Service API Calls Bundle - 6M

The UiPath licensing platform lists all SKUs relevant to Integration Service API calls.

Tip:

The Learn more button takes you to the Integration Service documentation page for Monitoring API usage.

How API usage is calculated and displayed

One API Call is determined as consumed when a call is made to the external third-party application through UiPath® Integration Service. The consumption is calculated on the number of times a call is made to the third-party applications, irrespective of how a call is initiated (manually, attended, unattended).

For organizations that have API allocation from Dedicated Bundle and Bundle with license, the consumption of API calls is first done from the monthly pool of Bundle with license before using the Dedicated Bundle pool.

Example: An organization that has 10 User Tier licenses (UiPath - Flex - Automation Developer - Named User) and 10 Robot Tier license (UiPath - Flex - Unattended Robot) has a total of (10 * 5,000 + 10 * 5,000) 100,000 API calls per month. The organization also has the Platform Individual SKU (UiPath - Flex - Integration Service API Calls Bundle - 3M), which gives another 3,000,000 API calls per year.

Let's say that for the month of October 2023, the total number of API calls consumed by the organization is 125,000. This means the organizations first used up all the 100,000 API Calls from the monthly allocation and another 25,000 from the 3M bundle. Starting November 1, 2023, the Organization now has 100,000 API calls for November and 2,975,000 calls from the 3M bundle.

Note: API calls made using the connectors mentioned below only include consumption charges for trigger, authentication, and test connection API calls. Calls not considered in this context are free of cost to the end user and have no impact on the functionality. The connector list is: Gmail, Google Sheets, Google Drive, Microsoft OneDrive (including SharePoint and Excel), Microsoft Outlook365, Microsoft Outlook 365EWS, Amazon Web Services, Microsoft Azure, Microsoft Azure AD, Google Cloud Platform, Citrix, VMware, and NetIQ.

License usage

Select View Usage to view the monthly usage. The License usage for Integration Service API calls graph shows the usage for the past 12 months. Consumption is displayed based on the license type the organization purchased (Dedicated Bundle and Bundle with license). The displayed consumption is tracked from the first to the last day of the month.

Note: The consumption is displayed from October 2023, when this feature was enabled for all organizations. Some customers might encounter a situation where they can also view some data for September 2023. This must be ignored as it might be partial and not reflecting the full month's usage.