Data egress reports in the Integration Hub Usage Dashboard
Summarize
Summary of Data egress reports in the Integration Hub Usage Dashboard
Data egress reports in the Integration Hub Usage Dashboard provide detailed insights into the volume of data leaving your ServiceNow instance via API protocols or export sets. These reports help you monitor and analyze data transfer trends over specific time periods, enabling better governance and optimization of your data flows.
Show less
Accessing and Navigating Reports
- Access reports by selecting the Data Egress tab in the dashboard.
- Use the Filter by list to switch between Overview, API, and Export sections, with Overview selected by default.
- Click on data volume numbers or chart segments to drill down into detailed records of individual data transfers.
Sections and Key Metrics
- Overview: Displays total data egress volume by all sources, breakdown by API protocols and export sets, and trends over time.
- API: Focuses on data egress by specific API protocols such as REST, SOAP, and JSON, with volume metrics and trend analysis.
- Export: Shows data egress by export sets and URIs, including volume and trend data.
All data volumes are presented in bytes, using standard abbreviations such as K (thousand), M (million), B (billion), and T (trillion) for readability.
Practical Use Cases
- Track total and source-specific data egress to identify high-volume data transfers.
- Analyze trends to understand data egress patterns over time for capacity planning and compliance.
- Drill down into individual transactions for detailed audit and troubleshooting purposes.
- Filter reports by date, API protocol, or export type to get focused insights on specific data movements.
Data Generation
The reports derive their information from the dataegresscount table, which aggregates data egress transactions for accurate reporting.
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
- 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.
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.
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.
| 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
Overview of data egress
View the total data egress, and the data egress by API protocols or exports.
- 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.
- 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.
- 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.
- 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.
- 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.
- Select the Data Egress tab.
- From the Filter by list, select Export.
Reports on data egress by export sets or URI
- 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.
- 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
.
The data appears.
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.