View API usage

The API usage tab provides a comprehensive view for monitoring and analyzing both REST and XML API activity across your entire company. For consoles, it shows API activity across multiple companies.

Subscription Company
Regional availability

All regions

User type Business user with admin privileges
Permissions

Administration:

  • Usage insights: View

Use API usage to identify issues and optimize your API integrations. If you identify any unsuccessful API transactions, you can export and share the data with your developers or third-party partners to fix them.

API usage displays information about successful and unsuccessful API transactions. However, it does not include data about rejections, for example if too many requests were made.

API usage includes API transactions originating from all sources for the current month and the previous 3 months. Your company's custom integrations, partner integrations, or Sage Intacct applications can make these transactions.

In-Product Dashboard Data

  • Metrics dashboards within the product refresh daily at 7:00 p.m. PST and typically complete within 30 minutes to an hour.

There's no refresh button for the dashboard.

  • The dashboards source data from a consolidated database that aggregates information across hundreds of servers.

  • The consolidation process can take 12 to 36 hours, which means dashboard data might be up to 2 days old at any given time.

Real-Time API Usage Data

  • Real-time API usage metrics are available in the product via the API Usage Detail and API Usage Summary objects.

  • For the most current insights, you can build custom reports based on these real-time sources.

The real-time data sources retain data for up to 60 days.

Sage Intacct defines API transactions as follows:

For write methods

  • Each record that is created, updated, or deleted counts as 1 transaction. Records include Intacct standard objects, such as customer, and custom objects.

  • Transaction records, such as bills and invoices that combine headers and line items in a single API method, count as 1 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 1 transaction.

For read methods

  • Each call of a read method counts as 1 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 1 transaction.

The following tables provide details about each component on the API usage tab.

Filters

The filters at the top of the page control the time frame and company information you view on the API usage tab.

Filters field descriptions
Field Description
Clear filters Clears the selections in all dropdown filters.
Application

Filter data by application. Each application corresponds to a unique Web Services sender ID.

The following are standard Intacct applications that you could potentially see on this page:

  • AJAX: In-product Intacct page scripts

  • sererra: SIG Fixed Assets, PEA, or Collection Notes

  • sfdc_prod_v2: Sage Intacct Advanced CRM Integration
Month

Filter by month and year.

You can select more than one month to filter by.
Date

Filter by date.

You can select individual dates to filter by. If you select a month first, the dates in this menu are restricted to the month and year you selected.
Company

If you’re logged into a company, you can only view usage for that company.

If you’re logged into a console, you can select from your list of companies.
Company type

Only available for consoles.

Select from the following:

  • deleted: Companies that were deleted from Intacct or have been marked for deletion.
  • archive: Read-only companies for reference or historical purposes.
  • debug: Temporary test companies, typically used for testing and diagnosing issues.
  • developer: Test companies provided to subscribers of web services for developer SKUs.
  • implementation: Temporary test companies, which serve as copies of production companies for implementation testing.
  • production: Live companies that are actively in use.
  • salesdemo: Demo companies that are used for sales demonstrations.
  • sandbox: Sandbox companies that customers purchase. They’re copies of production companies.
  • training: Companies used for training programs.
  • trial: Companies participating in trial programs.

Tiles

Tiles field descriptions
Field Description
Applications

Only available for companies.

The total number of applications identified. Each application corresponds to a unique Web Services sender ID.
Companies

Only available for consoles.

The total number of companies in your console.
Total API Transactions

The total number of API transactions counted, including successful and unsuccessful transactions.

Sage Intacct defines API transactions as follows:

For write methods

  • Each record that is created, updated, or deleted counts as 1 transaction. Records include Intacct standard objects, such as customer, and custom objects.

  • Transaction records, such as bills and invoices that combine headers and line items in a single API method, count as 1 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 1 transaction.

For read methods

  • Each call of a read method counts as 1 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 1 transaction.
Completed API Transactions The number of API transactions that were successfully completed.
Failed API Transactions

The number of API transactions that were unsuccessful.

The circle shows the percentage of unsuccessful API transactions out of the total transaction count.

Graphs

Graphs field descriptions
Field Description
API transactions by date

The API transactions by date graph shows the number of successful and unsuccessful transactions over time. You can hover over one of the bars to view more information.

Last refreshed: The date that the page was last refreshed is displayed at the top right of the graph. The page automatically refreshes its data each day at 6 PM PST.

Tables

Tables field descriptions
Field Description
Transactions by company

Only available for consoles.

The Transactions by company table shows the following for each company:

  • Company name
  • The total number of API transactions
  • The number of unsuccessful API transactions
  • The percentage of unsuccessful API transactions
Transactions by application

The Transactions by application table shows the following for each application:

  • Application name (sender ID)
  • The total number of API transactions
  • The number of unsuccessful API transactions
  • The percentage of unsuccessful API transactions
Transactions by function

The Transactions by function table shows the following data for each function of an application, per day:

  • Date
  • Company name (only available for consoles)
  • Application name (sender ID)
  • Function name
  • The total number of API transactions
  • The number of unsuccessful API transactions
  • The percentage of unsuccessful API transactions