Skip to content

SDK Overview

The Nveal SDK is a lightweight JavaScript library that captures user interactions and DOM changes in your web application. It is designed to be non-intrusive and highly configurable.

Core Capabilities

  • Event Capture: Automatically records mouse movements, clicks, scrolls, and input events.
  • DOM Snapshots: Captures periodic snapshots of the DOM to ensure accurate replays.
  • Metadata: Attach custom data to sessions (e.g., User IDs, Order IDs) for easier searching.
  • Resource Optimization: Events are batched and compressed before being sent to the server.

How it works

The SDK initializes a recording session and listens for events. It uses a "snapshot and delta" approach: 1. Full Snapshot: A complete capture of the initial DOM state. 2. Incremental Deltas: Only the changes (mutations) are recorded thereafter.

This ensures that session data remains small and efficient to transmit.

Compatibility

The SDK is compatible with all modern browsers: - Chrome / Chromium (latest) - Firefox (latest) - Safari (latest) - Edge (latest)

Note

Internet Explorer is not supported.

Next: Installation