Data egress reports in the Integration Hub Usage Dashboard

  • Release version: Yokohama
  • Updated April 24, 2025
  • 4 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Data egress reports in the Integration Hub Usage Dashboard

    The 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 track and analyze data egress over time, aiding in monitoring usage, compliance, and performance of integrations and data exports.

    Show full answer Show less

    Accessing and Navigating Reports

    • Access: Go to the Data Egress tab in the Usage Dashboard.
    • Filtering: Use the "Filter by" list to select Overview, API, or Export sections to focus the reports on total data egress, specific API protocols, or export sets respectively.
    • Interactive details: Selecting numerical data points or chart elements lets you drill down to individual data transfers and transaction logs for detailed analysis.

    Report Sections and Key Metrics

    • Overview: Shows total data egress volume, breakdown by API protocols and exports, and trends over selected time periods.
    • API section: Displays total and protocol-specific data egress volumes (e.g., REST, SOAP, JSON) along with trend analysis.
    • Export section: Reports data egress by export sets and URI, including volume and trends.

    All data volumes are presented in bytes, using standard abbreviations (K for thousand, M for million, B for billion, T for trillion) for clarity.

    Using Date and Source Filters

    You can specify dates and sources (API protocols or export types) to view data egress for particular periods or integration types. This supports detailed temporal analysis of data flow through your instance’s integrations and exports.

    Data Detail and Drill-Down

    • Clicking on specific data points or segments reveals individual data transfer records.
    • The “View Aggregate Breakdown” icon opens transaction logs for deeper inspection of data egress events.

    Data Source

    The reports are generated from the dataegresscount table, which stores the underlying data on data egress volumes and transactions.

    Practical Benefits for ServiceNow Customers

    • Monitor and manage your instance’s outbound data flows to optimize performance and control costs.
    • Identify trends and peak periods of data egress to support capacity planning and security compliance.
    • Gain detailed visibility into specific API protocols and export sets to troubleshoot or audit data transfers.

    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.
    1. Select the Data Egress tab.
    2. 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.
    1. Select the Data Egress tab.

      Confirm that in the Filter by list, Overview is selected.

    2. Select the data egress volume in the Data Egress report.

      Total data egress volume.

      The data egress by API protocols and exports appear.

      Data egress by API protocols and exports.

    Data egress by API protocols or exports

    View data egress by various API protocols or exports.

    Do the steps.
    1. Select the Data Egress tab.

      Confirm that in the Filter by list, Overview is selected.

    2. On the Data Egress by source report, select a source.

      Data egress by API protocols and exports.

      For example, select API.

      The data egress by API protocols such as REST and SOAP appears.

      Data egress by sources.

    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.
    1. Select the Data Egress tab.

      Confirm that in the Filter by list, Overview is selected.

    2. On the Data Egress Trends report, move the pointer to a date and then select the source.

      Date and source selection for data egress report.

      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.
    1. Select the Data Egress tab.
    2. From the Filter by list, select API.
    3. In the Data Egress by API Protocols report, select an API protocol, for example, REST.

      Selection of an API protocol.

      All records of data egress by the API protocol that you specified appears.

      Data egress shown by the API protocol that you specified.

    4. To view more data on a specific record, select the View Aggregate Breakdown icon Drill down icon..

      Select the View Aggregate Breakdown icon.

      The transaction log appears.

      Transaction log.

    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.
    1. Select the Data Egress tab.
    2. From the Filter by list, select API.
    3. Move the pointer to a date on the graph, and select an API protocol.

      API protocol graph.

      The data egress by the selected API protocol on the selected date appears.

      Data egress by date.

    4. To view more data on a specific record, select the View Aggregate Breakdown icon Drill down icon..

      Data egress API trends.

      The transaction log appears.

      Transaction log.

    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.
    1. Select the Data Egress tab.
    2. 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.
    1. On the Data Egress by Exports report pie-chart, select the data export type. For example, export sets.

      Data egress by export type.

      The date-wise data exports by the source you specified appears.

      Export source-wise data.

    2. To view more information on an export set on a date, select the View Aggregate Breakdown icon Drill down icon..

      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.
    1. 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.

      Data export by export type on a date.

      The egress data on the export type and date that you specified appears.

      Date-wise and source-wise egress data.

    2. To view more data on a specific record, select the View Aggregate Breakdown icon Drill down 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.