Bulk export of Usage Insights data via REST API

  • Release version: Zurich
  • Updated August 11, 2026
  • 2 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 Bulk export of Usage Insights data via REST API

    The Usage Insights data export store app enables ServiceNow customers to programmatically export large volumes of usage data from their instances using an asynchronous REST API. This process supports integration with enterprise analytics platforms by streaming JSON-formatted usage data in batches to a dedicated Kafka topic. Unlike manual exports from the Usage Insights dashboard, this solution is optimized for automated, recurring data extraction and ingestion.

    Show full answer Show less

    Key Features

    • Asynchronous Export Process: Submit export requests specifying data source, columns, and filters; receive an immediate job ID while data is processed in the background.
    • Kafka Integration: Exported data is published in JSON batches to a dedicated Kafka topic, allowing real-time consumption via secure Kafka clients.
    • Large-Volume Support: Designed to handle up to 100 GB of data per account per month, suitable for extensive and recurring data movement scenarios.
    • Secure Connectivity: SSL encryption is configured for Kafka consumers using instance-signed certificates to securely connect to the Hermes-managed Kafka cluster.
    • Event Data Source Support: Currently supports exporting usage data from the events data source.

    Comparison with Usage Insights Dashboard Export

    • Volume and Frequency: Dashboard export is manual and suited for small, quick data downloads; the REST API export supports automated, large-volume, scheduled exports.
    • Result Format: Dashboard exports files in CSV or JSON; REST API streams JSON batches to Kafka.
    • Integration: Dashboard exports require manual download and transfer; REST API exports flow directly into Kafka consumer environments for seamless ingestion.
    • Processing: Dashboard export is synchronous; REST API export is asynchronous.

    Usage Limits and Recommendations

    • Maximum of 60 export requests per hour per instance, shared across all users and applications.
    • Export results are retained on the Kafka topic for 36 hours; customers must consume data within this period.
    • Each export request can cover up to 90 days of data.
    • Monthly export volume is capped at 100 GB per customer account (aggregated across instances).
    • To optimize usage and stay within limits, select only necessary columns and apply filters.

    Practical Steps for ServiceNow Customers

    • Submit Export Requests: Use the REST API to initiate asynchronous export jobs specifying the required data parameters.
    • Configure Secure Kafka Connections: Generate instance-signed SSL certificates and configure your Kafka clients to securely connect to the Hermes cluster where results are published.
    • Consume Exported Data: Retrieve exported usage data in JSON batches from the Kafka topic using standard Kafka clients within the 36-hour retention window.

    Usage Insights data export is a store app that enables you to programmatically export Usage Insights usage data from your ServiceNow® instance for integration with your enterprise analytics platform.

    Overview of Usage Insights data export with REST API

    Usage Insights data export delivers an asynchronous REST API endpoint that processes export requests in the background and streams results as JSON batches to a dedicated Kafka topic. Unlike manual export from the Usage Insights dashboard, data export is designed for programmatic, large-volume, recurring data movement scenarios.

    The data export process follows a request-and-response model:

    1. You submit an export request to the API, specifying the data source, columns, and optional filters.
    2. The instance validates the request and returns a job ID immediately—the data itself is not returned in the API response.
    3. The export is processed asynchronously. As results are produced, they are published in batches to a dedicated Kafka topic provisioned for your instance.
    4. You consume result batches from the topic using a standard Kafka client, secured with SSL certificates.
      Note:
      Usage Insights data export supports events data source.

    Data export compared to Usage Insights dashboard export

    The Usage Insights dashboard provides a built-in export function for quick and small-volume data downloads. Bring ServiceNow® usage data into tools like Microsoft Power BI, Tableau, or your enterprise data warehouse so you can analyze it alongside data from other sources.

    Create end-to-end views of user behavior that spans ServiceNow and other platforms in your technology stack. Data export is a different capability designed for different use cases:

    Feature Usage Insights Dashboard Export Data Export Store App
    Volume Suitable for small-volume, quick exports Handles large volumes on a recurring schedule (up to 100 GB per account per month)
    Frequency Manual export triggered by dashboard user Programmatic export driven by automated API calls and scheduled jobs so that so data flows directly to your analytics infrastructure without manual intervention.
    Result format Downloaded as CSV or JSON file Streamed as JSON batches to a Kafka topic
    Integration User downloads and transfers file manually Results flow directly into your Kafka consumer environment for real-time ingestion
    Asynchronous processing Synchronous response; export completes before download Asynchronous; results arrive on the topic as processing completes

    Rate and usage limits

    Limit Value Notes
    Requests per hour 60 per instance Shared across all users and applications on the instance. Additional requests are throttled.
    Result retention 36 hours Results remain on the topic for 36 hours. Consume them before they expire.
    Date range per request Up to 90 days A single request can't span more than 90 days.
    Monthly export volume 100 GB per account/ month Applies per customer account, aggregated across instances, on a calendar-month basis (Base tier).
    Note:
    Select the columns you need and apply filters to keep export volume within the rate and usage limits.