--- title: "Usage Bundle" slug: "usage-bundle" description: "Learn about the Usage Bundle, its configuration, and how it aids in usage-based billing and tracking processing volumes in your Hyperscience instance." updated: 2026-10-14T19:43:18Z published: 2026-10-14T19:43:18Z canonical: "help.hyperscience.ai/usage-bundle" --- > ## Documentation Index > Fetch the complete documentation index at: https://help.hyperscience.ai/llms.txt > Use this file to discover all available pages before exploring further. # Usage Bundle The **Usage Bundle** is a ZIP file that summarizes how your Hyperscience instance is used and configured. It does not contain end-user data or Personally Identifiable Information (PII). Hyperscience uses this information for usage-based billing. You can also use it to track processing volumes, automation, and configuration changes. > [!NOTE] > An on-premise instance must be connected to the internet to send a Usage Bundle to Hyperscience. You can download the bundle without an internet connection. ## Required permissions You need the **View Usage Reports** permission to open the Usage page, download or send a bundle, and view transmission history. By default, this permission is assigned to the **System Administrator** and **Business Administrator** groups. ## What the Usage Bundle contains The ZIP file contains a root folder and up to two subfolders: | Location | Contents | | --- | --- | | Root folder | Application usage, instance configuration, browser usage, and machine and Supervision transcription reports. | | *product_analytics* | Anonymized data about flows, settings, accuracy, throughput, resources, models, and infrastructure. Included only when product analytics data is requested. | | *daily_metrics* | Classification events and reclassified-document data from the previous day. Included only when daily metrics are requested. | For the full list of files and every column each one reports, see [Usage Bundle metrics](/v44/docs/usage-bundle). ## Product analytics Product analytics describes how your organization uses flows, settings, and other application features. It contains no PII, is not collected automatically, and is not used for billing. When shared, it helps Hyperscience improve the product. The *product_analytics* CSV files can record the following events without identifying the user: - Page views - Sign-ins and sign-outs - Requests to Hyperscience API endpoints - Clicks on **Perform Tasks** - Application-settings changes, imports, and exports ## Usage Bundle Transmissions Once a day, the system generates a Usage Bundle and sends it to Hyperscience. Sensitive configuration values, such as proxy credentials, are removed before transmission. - Automatic transmission is enabled by default. - The schedule and bundle contents cannot be changed. - Each bundle covers the previous day. In v43.0, it covered the previous seven days. During a transmission, the system: 1. Creates a transmission record. 2. Generates the bundle. 3. Starts the **Send Usage Bundle** flow. 4. Requests an upload URL and uploads the file. The Usage Bundle Transmissions table shows the current result. ### When a transmission fails In v43.1 and later, a failed scheduled or backfill transmission is retried once an hour for up to 30 days. v43.0 does not retry failed transmissions. - Automatic retries apply only to scheduled and backfill transmissions. - A transmission you started yourself is never retried automatically. ### Backfill In v43.2 and later, each scheduled transmission checks for missing reporting days. The system creates a separate backfill transmission for each missing day. If one backfill fails, the others continue. Each run processes a limited backlog: - The system backfills at most ten missing days and retries at most ten failed transmissions per run. Remaining days are picked up by later runs. - A day whose only transmission failed is not treated as missing, because the retry path already covers it. ### Configuration Depending on your organization's security measures, you may need to configure a proxy, a firewall, or a custom CA bundle to allow transmission. If your instance is not connected to the internet, you need to disable automatic transmission. To learn more, see [Automatic Transmission of Usage Data](/deployment/docs/automatic-transmission-of-usage-data). ## Starting a transmission yourself In v43.1 and later, you can send a Usage Bundle from the Usage page instead of waiting for the daily transmission. - You can do this even when `HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_ENABLED` in your `.env` file is set to `false`. ## How long transmission records are kept The **Submission record deletion policy** controls how long Usage Bundles and their transmission records are kept. You can find it under **Administration** > **System Settings**. When the policy deletes submissions for a day, it also deletes the related Usage Bundle and transmission records. If a transmission record remains after its Flow Run or file is deleted, the related column shows **(data deleted)** instead of a link. For more information about the **Submission record deletion policy** setting, see [PII Data Deletion](/v44/docs/pii-data-deletion#submission-record-deletion-policy). ## Working with the Usage Bundle Go to **Reporting** > **Usage**. Use the **Usage Bundle** card to download or send a bundle. Use the **Usage Bundle Transmissions** card to check transmission health and history. ### Download a Usage Bundle 1. On the **Usage Bundle** card, select a period from the drop-down list: **Week to Date**, **Month to Date**, **Year to Date**, or **Select Date Range**. 2. If you selected **Select Date Range**, choose a starting and ending date. 3. Click **Download**. ### Start a transmission On the **Usage Bundle** card, select a period as described above, and then click **Send**. A confirmation message appears, and the new transmission is added to the Usage Bundle Transmissions table. ### Check transmission health The **Usage Bundle Transmissions** card shows the latest resolved transmission status and the time of the latest successful scheduled, backfill, or manual transmission. For what each status value means, see [Transmission health statuses](/v44/docs/usage-bundle#transmission-health-statuses). ### Review transmission history Click **show transmissions** to open the table. It lists scheduled, backfill, and manual transmissions. Click **hide transmissions** to close it. For column details, see [Usage Bundle Transmissions table columns](/v44/docs/usage-bundle#usage-bundle-transmissions-table-columns). ![The Usage Bundle Transmissions table, listing transmissions by creation date with their date range and status.](https://cdn.us.document360.io/87894cef-4958-4f3f-be6f-b75a78c82548/Images/Documentation/usage-transmissions.png?sv=2026-02-06&spr=https&st=2026-10-31T08%3A28%3A02Z&se=2026-10-31T09%3A28%3A02Z&sr=c&sp=r&sig=FohoPzIMzrMIhkBcpfmDZXvkbbVxqCLWZSFmEA6lupg%3D) ### Add or remove columns With the table open: 1. Click the menu in the upper-right corner of the card ( ![Three-dot menu icon](https://cdn.us.document360.io/87894cef-4958-4f3f-be6f-b75a78c82548/Images/Documentation/ThreeDotsMenu.png?sv=2026-02-06&spr=https&st=2026-10-31T08%3A28%3A02Z&se=2026-10-31T09%3A28%3A02Z&sr=c&sp=r&sig=FohoPzIMzrMIhkBcpfmDZXvkbbVxqCLWZSFmEA6lupg%3D) ), and then click **Manage columns…**. 2. Select or deselect the checkboxes for the columns you want to show or hide. To restore the default selections, click **Reset**. 3. Click **Save**. ### Filter and sort the table Use the date control to choose a custom range, **Today**, **Last 7 Days**, or **Last 30 Days**. Use **All Statuses** to filter by **Completed**, **In Progress**, **Warning**, or **Failed**. Click **Created**, **Updated**, **From Date**, or **To Date** to sort. Click again to reverse the order. ## Usage Bundle Transmissions table columns In v43.1 and later, the table contains these columns: | Column | Description | Shown by default | | --- | --- | --- | | **Created** | The date and time the Usage Bundle's creation was initiated. | Yes | | **Updated** | The date and time the transmission was last updated. | Yes | | **From Date** | The starting date of the Usage Bundle's data. | Yes | | **To Date** | The ending date of the Usage Bundle's data. | Yes | | **Status** | The state of the transmission. See [Transmission statuses](/v44/docs/usage-bundle#transmission-statuses). | Yes | | **Flow Run** | An **Inspect** link to the flow run that transmitted the bundle. Shows **(data deleted)** when the flow run has been deleted, and a dash when no flow run was started. | No | | **File** | A **Download** link for the transmitted Usage Bundle. Shows **(data deleted)** when the file has been deleted, and a dash when no file was generated. | No | ## Transmission statuses The **Status** column shows one of these values. Hover over a status to see its meaning. | Status | Meaning | | --- | --- | | **Completed** | The Usage Bundle was generated and uploaded successfully. | | **In Progress** | The flow is generating and uploading the Usage Bundle. | | **Warning** | The transmission hit a recoverable failure and will keep retrying automatically. | | **Failed** | The transmission used all of its automatic retry attempts and will not be retried. | ## Transmission health statuses The card summarizes the latest resolved transmission with one of these values. | Status | Meaning | | --- | --- | | **Healthy** | The most recent finished transmission completed successfully. | | **Latest transmission needs attention** | The most recent finished transmission hit a recoverable failure and is still being retried. | | **Latest transmission failed** | The most recent finished transmission used all of its automatic retry attempts and will not be retried. | | **Disabled** | Automatic Usage Bundle transmission is turned off for this instance. | Any data that can be used to identify an individual, such as a name, address, or Social Security number. The complete execution cycle of a specific flow within Hyperscience. Each flow run encompasses all steps from initiation to completion for a given submission, allowing you to monitor, troubleshoot, and manage document processing.