Monitor inbound API integration usage
Summarize
Summary of Monitor inbound API integration usage
The Inbound API Integration Usage dashboard in ServiceNow enables you to monitor inbound API integration requests, data egress, and domain-level usage effectively. This dashboard provides visual insights to help you track how your inbound integrations are performing and consuming resources.
Show less
Access to this dashboard requires the inboundintegrationmeteringadmin role, allowing you to review usage data across three main areas: Transactions, Data Egress, and Usage by Domain.
Transactions Tab
This tab displays the number of inbound integration requests, helping you identify request patterns and high-usage entities. Key visualizations include:
- Total integration requests for today and historical data over the past 30 days and 13 months.
- Integration requests segmented by OAuth provider, requestor, application, and resource.
Use this tab to monitor which applications or users are generating the most inbound API calls.
Data Egress Tab
This tab shows the volume of data returned in integration responses, measured in megabytes or gigabytes. It helps track API access volume usage by service account, user, and application. Key visualizations include:
- Data egress totals for today, daily over 30 days, and monthly over 13 months.
- Data egress broken down by OAuth provider, requestor, and application.
This insight is useful for understanding data consumption and its impact on Workflow Data Fabric usage.
Usage by Domain Tab
Available only when domain separation is enabled, this tab breaks down inbound integration requests and data egress by domain. It helps attribute usage across multiple domains configured on your instance. Key visualizations include:
- Integration requests and data egress by domain, displayed daily for 30 days and monthly for 13 months.
Administrators can see usage across all domains regardless of domain membership.
Additional Features
You can also view a comprehensive list of all inbound API integrations registered on your ServiceNow instance, aiding in management and auditing of integrations.
Practical Benefits for ServiceNow Customers
- Gain clear visibility into API request volumes and data egress to optimize integration performance and costs.
- Identify high-usage applications or users to manage API consumption effectively.
- Monitor usage across domains for better governance in multi-domain environments.
- Use historical data trends to plan capacity and troubleshoot issues.
Monitor inbound integration usage requests, data egress, and domain-level usage through the Inbound API Integration Usage dashboard.
The Inbound API Integration Usage dashboard contains visualizations that help you assess the usage of your inbound integration calls. With the inbound_integration_metering_admin role, you can view usage data across three tabs: Transactions, Data Egress, and Usage by Domain.
Transactions tab
The Transactions tab shows the number of inbound integration requests. Use this tab to monitor request counts and identify which applications, requestors, or resources are making the most requests.
| Visualization | Description |
|---|---|
| Integration Requests Today | Total integration request count for the current day. |
| Integration Requests (Daily) | Number of integration requests for each day over the last 30 days. |
| Integration Requests (Monthly) | Number of integration requests for each month over the last 13 months. |
| Integration Requests by Provider | Number of integration requests by OAuth provider. |
| Integration Requests by Requestor (Daily) | Number of integration requests by requestor for each day over the last 30 days. |
| Integration Requests by Requestor (Last 30 days) | Number of integration requests by requestor over the last 30 days. |
| Integration Requests by Application (Last 30 days) | Number of integration requests by OAuth application over the last 30 days. |
| Integration Requests by Resource (Last 30 days) | Number of integration requests by resource over the last 30 days. |
Data Egress tab
The Data Egress tab shows the data volume returned in integration responses. Use this tab to identify which applications or requestors have the highest data egress, and monitor API access volume usage by service account, user, and application. For more information on how inbound API integrations contribute to Workflow Data Fabric usage, see the Integration Hub Usage Dashboard.
| Visualization | Description |
|---|---|
| Data Egress Usage - Today (MB) | Total data egress for the current day. |
| Data Egress Usage - Daily (MB) | Data egress for each day over the last 30 days. |
| Data Egress Usage - Monthly (GB) | Data egress for each month over the last 13 months. |
| Data Egress Usage by Provider (GB) | Data egress by OAuth provider. |
| Data Egress Usage by Requestor - Daily (MB) | Data egress by requestor for each day over the last 30 days. |
| Data Egress Usage by Application - Last 30 days (GB) | Data egress by OAuth application over the last 30 days. |
Usage by Domain tab
The Usage by Domain tab shows the number of inbound integration requests and data egress volume broken down by domain. Use this tab to attribute usage across the domains configured on your instance, not to investigate individual requests.
Users with the admin role see usage across all domains regardless of which domain they belong to.
| Visualization | Description |
|---|---|
| Integration Requests - Daily | Number of integration requests by domain for each day over the last 30 days. |
| Integration Requests - Monthly | Number of integration requests by domain for each month over the last 13 months. |
| Data Egress Usage - Daily (MB) | Data egress by domain for each day over the last 30 days. |
| Data Egress Usage - Monthly (GB) | Data egress by domain for each month over the last 13 months. |