The Acoustic Analytics Developer Hub

Welcome to the Acoustic Analytics developer hub. You'll find comprehensive guides and documentation to help you start working with Acoustic Analytics as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Installation on web pages

Installation on web pages

When you plan the installation of the UI Capture library, consider that it does use system resources to process on the website and the Acoustic Experience Analytics (Tealeaf) capture systems. Install the library only on the pages that you want to capture and replay.

Installing the UI Capture library can cause the following effects.

  • Page load times can increase slightly during first download. Acoustic Experience Analytics (Tealeaf) provides strategies for minimizing the effect on load times, including caching the JavaScript after initial download.
  • More data is posted by the web page to the server, but it is not processed.
    • Acoustic Experience Analytics (Tealeaf) must process and store the additional data.
      Acoustic Experience Analytics (Tealeaf) UI Capture is designed to minimize these burdens.

Unique HTML IDs

To capture the client events for a Document Object Model object, each object or control available with which the visitor can interact must have a unique HTML ID. Without unique IDs, Acoustic Experience Analytics (Tealeaf) cannot properly replay the UI events in the page.

If you did not instrument your application to support unique IDs or unique names in the document object model, Acoustic Experience Analytics (Tealeaf) UI Capture automatically generates paths to the node that support the requirement of uniqueness.

Acoustic Experience Analytics (Tealeaf) also supports the creation of ID black lists, which forces the use of Xpath or name attribute values as identifiers. See UI Capture reference for more information.


The web session must use cookies for sessionization. Cookies allow the client events to send messages without having to understand the sessionization mechanism.

For best results in capturing client UI events, deploy the Acoustic Experience Analytics (Tealeaf) Cookie Injector in your web server environment. The Acoustic Experience Analytics (Tealeaf) Cookie Injector provides unique session IDs regarding captured Acoustic Experience Analytics (Tealeaf) session data.

Updated about a month ago

Installation on web pages

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.