save (SPA API)

Syntax

newrelic.interaction().save()

Ensures a SPA browser interaction will be saved when it ends.

Requirements

• Browser Pro+SPA agent (v963 or higher)

• If you're using npm to install the browser agent, you must enable the spa feature when instantiating the BrowserAgent class. In the features array, add the following:

  import { Spa } from '@newrelic/browser-agent/features/spa';
  
  const options = {
    info: { ... },
    loader_config: { ... },
    init: { ... },
    features: [
      Spa
    ]
  }

  Copy

  For more information, see the npm browser installation documentation.

Description

This SPA method ensures a browser interaction will be saved when it ends. Normally an interaction is only saved and sent to New Relic if it is an initial page load or if it results in a URL or hash change. You must call this method to override this behavior and guarantee the interaction will be recorded.

Return values

This method returns the same API object created by interaction(), which is associated with a BrowserInteraction event.

Examples

window.addEventListener('scroll', () => {
  if (atBottomOfPage()) {
    newrelic.interaction() // Start monitoring this interaction.
      .setName('loadNextPage') // Set name of interaction.
      .save(); // Ensure that this interaction will be saved as a BrowserInteraction event when it ends.
    loadNextPage(); // Start loading the next page.
  }
});