Data egress reports in the Integration Hub Usage Dashboard

Release version: Xanadu

Updated April 24, 2025

4 minutes to read

Summarize

Summarized using AI

Summary of Data egress reports in the Integration Hub Usage Dashboard

The Data egress reports in the Integration Hub Usage Dashboard provide ServiceNow customers with detailed insights into data leaving their ServiceNow instance via APIs or export sets. These reports help you monitor the volume and trends of data egress, enabling you to manage and audit data transfers effectively.

Show full answer Show less

Accessing and Navigating the Reports

To view data egress reports:

Select the Data Egress tab in the dashboard.
Use the Filter by list to choose between Overview (default), API, or Export sections.

Report Sections and Their Insights

Overview Section: Displays total data egress volume by all sources, data egress volume by API protocols and exports, plus trends over time. All data is measured in bytes with standard abbreviations (K, M, B, T) to indicate magnitude.
API Section: Focuses on data egress volume specifically from API protocols like REST, SOAP, and JSON, along with trends and detailed transaction logs.
Export Section: Details data egress via export sets and URIs, showing volumes and trends, with the ability to drill down into specific export types and dates.

Key Features and Functionalities

Interactive Data Drill-Down: Selecting data points or volumes in reports opens detailed views of individual data transfers or transaction logs, enhancing traceability.
Date-Specific Analysis: You can filter and view data egress by specific dates and sources, supporting precise monitoring and auditing.
Trend Visualization: Graphs and charts illustrate data egress trends over time, helping you identify patterns or unusual spikes.
Data Magnitude Understanding: The reports use consistent abbreviations (K, M, B, T) for byte counts, clarifying the scale of data transferred.

Practical Use for ServiceNow Customers

These reports enable customers to:

Monitor total and source-specific data egress for compliance and governance.
Identify which API protocols or export sets are responsible for significant data transfers.
Analyze data egress trends to optimize integrations and manage data usage efficiently.
Investigate detailed transaction logs for specific data egress events to support troubleshooting and audits.

Data Source

The reports are populated from the dataegresscount table, ensuring accurate and up-to-date data egress tracking.

The Data egress reports give insights on data egress from the ServiceNow instance through API protocols or export sets. You can view more information when you select specific records.

Access the reports

Do the following steps.

Select the Data Egress tab.
Select the API or Export section that you want to view from the Filter by list.
Note:
The Overview section is selected by default.

Overview section reports

Data Egress: Total volume of data egress by all sources.

Data Egress by source: Data egress volume by API protocols and export.

Data Egress Trends: Trends in data egress across the time period.

Overview section that shows data egress.

Note:

All charts are adjusted to the nearest data metric starting with Bytes.

API section reports

Data Egress: Total volume of data egress by all API protocols.

Data Egress by API Protocols: Data egress volume by API protocols.

Data Egress Trends: Trends in data egress across the time period.

API section showing data egress by protocols.

Note:

All charts are adjusted to the nearest data metric starting with Bytes.

Export section reports

Data Egress: Total volume of data egress by both the export sets and URI.

Data Egress by Exports: Data egress volume by URI.

Data Egress Trends: Trends in data egress across the time period.

Note:

All charts are adjusted to the nearest data metric starting with Bytes.

Important:

The amount of data is mentioned in bytes and the abbreviations are as described in the following table.

Table 1. Orders of magnitude
Abbreviation	Number	Value
K	Thousand	10^3
M	Million	10^6
B	Billion	10^9
T	Trillion	10^12

That is, if the value displayed is 4.01M, the amount of data transferred is 4.01 million bytes. In the preceding sample API Data Egress, the data amount of data transferred is 2.01 billion bytes.

Select the number to access details of the individual data transfers.

View data insights

View different insights on data going out of the ServiceNow instance. For example, view the data egress volume between a period that you specify. Do the actions given in the image.

View egress data for a specified time period

Filter to specify date range.

Overview of data egress

View the total data egress, and the data egress by API protocols or exports.

Do the steps.

Select the Data Egress tab.
Confirm that in the Filter by list, Overview is selected.
Select the data egress volume in the Data Egress report.
The data egress by API protocols and exports appear.

Data egress by API protocols or exports

View data egress by various API protocols or exports.

Do the steps.

Select the Data Egress tab.
Confirm that in the Filter by list, Overview is selected.
On the Data Egress by source report, select a source.
For example, select API.
The data egress by API protocols such as REST and SOAP appears.

View data egress by API protocols or exports on a specified date

Select a date and API protocol or exports and view the data egress by the source you specified on that date.

Do the following steps.

Select the Data Egress tab.
Confirm that in the Filter by list, Overview is selected.
On the Data Egress Trends report, move the pointer to a date and then select the source.
All records of data egress by the date and source that you specified appears.

View data egress by API protocols

View data egress by JSON, REST, or SOAP protocols, and then select a record from the data to view more information.

Do the steps.

Select the Data Egress tab.
From the Filter by list, select API.
In the Data Egress by API Protocols report, select an API protocol, for example, REST.
All records of data egress by the API protocol that you specified appears.
To view more data on a specific record, select the View Aggregate Breakdown icon .
The transaction log appears.

View data egress by API protocols on a specified date

Specify a date and view the data egress by JSON, REST, or SOAP protocols on that date. You can select a record from the data to view more information.

Do the steps.

Select the Data Egress tab.
From the Filter by list, select API.
Move the pointer to a date on the graph, and select an API protocol.
The data egress by the selected API protocol on the selected date appears.
To view more data on a specific record, select the View Aggregate Breakdown icon .
The transaction log appears.

Reports on data egress by export

View information on the data egress from the ServiceNow instance by URI and export sets.

To access the reports, do the steps.

Select the Data Egress tab.
From the Filter by list, select Export.

Reports on data egress by export sets or URI

To access the reports on data egress by export sets or URI, do the steps.

On the Data Egress by Exports report pie-chart, select the data export type. For example, export sets.
The date-wise data exports by the source you specified appears.
To view more information on an export set on a date, select the View Aggregate Breakdown icon .
The data appears.

Date-wise data egress by exports

View data egress by exports on a date that you specify.

Do the following steps.

On the Data Egress Trends report, move the pointer to a date and then select the export type. For example, move the pointer to April 19, and then select Export Sets.
The egress data on the export type and date that you specified appears.
To view more data on a specific record, select the View Aggregate Breakdown icon .

View Aggregate Breakdown icon.

The data appears.

Drill-down data.

Data generation in the reports

Data in the reports are generated from the data_egress_count table. View how data is populated in the data_egress_count.