Company and Administration
View your API usage
The new API usage dashboard provides a comprehensive view for monitoring and analyzing API activity across your entire company. You can use it to quickly identify issues and optimize your API integrations.
Unlike the existing API metrics dashboard in the Sage Developer Workspace, which only provides data from a single Web Services sender ID, this new dashboard provides a complete view of all API activity in your company.
Details
The API usage dashboard includes API transactions originating from Web Services and AJAX calls for the current month and the previous 3 months. These transactions can be made by your company's custom integrations, partner integrations, or by Sage Intacct's applications.
Sage Intacct defines API transactions as follows:
For write methods
-
Each record that is created, updated, or deleted counts as one transaction. This includes Intacct standard objects, such as customer and GL batch, and custom objects.
-
Transaction records, such as bills and invoices that combine headers and line items in a single API method, count as one transaction, even if the record has multiple line items.
-
Complex records, such as contracts and contract lines that have separate API methods for their headers and line items, count each method call as one transaction.
For read methods
-
Each call of a read method counts as one transaction, regardless of the number of records returned.
-
Sometimes, a read method may return multiple pages of records. In this case, the readMore method is used to return additional pages. Each call of readMore counts as one transaction.
From the dashboard, you can:
- Filter by Application, Company, Month, or Date.
- View usage data about the number of API transactions by application (sender ID) and function.
- Identify and export unsuccessful transactions to share with developers or third-party partners.
How it works
The dashboard is accessible by default for users with admin privileges.
- Go to Company > Admin > Usage metrics > API usage.
Requirements
| Subscription |
Company |
|---|---|
| Regional availability |
All regions |
| User type |
Business user with admin privileges |
| Permissions |
Administration:
|
