Insights Plugin

Track what entries and Ninetailed Experiences are being viewed to power Component Insights.

How It Works

The Insights plugin sends data to a Ninetailed Insights API endpoint via the Beacon API when an <Experience> component remains in the viewport for a specified amount of time. This view data powers Component Insights and Experience Insights.

Installation

The Insights Plugin requires that you are using major version 6.x or above of one of Ninetailed's SDKs. Ensure that all of your other @ninetailed dependencies are also using the same version.

Add the dependency:

npm

npm install @ninetailed/experience.js-plugin-insights

yarn

yarn add @ninetailed/experience.js-plugin-insights

Then, add the plugin to the Ninetailed instance:

React, Next.js

import { NinetailedInsightsPlugin } from '@ninetailed/experience.js-plugin-insights'

<NinetailedProvider
  // ...
  plugins={[
    new NinetailedInsightsPlugin()
  ]}
  componentViewTrackingThreshold={2000} // (Optional prop) Number, default = 2000
>
  // ...
</NinetailedProvider>;

Gatsby

gatsby-config.(js|ts)

plugins: [
    // ...
    {
        resolve: `@ninetailed/experience.js-plugin-gatsby`,
        options: {
            // ...
            componentViewTrackingThreshold: 2000 // (Optional prop) Number, default = 2000
            ninetailedPlugins: [
                // ...
                {
                    resolve: `@ninetailed/experience.js-plugin-insights`,
                    options: {}
                }    
            ]
        }
    }
]

JavaScript

import { Ninetailed } from '@ninetailed/experience.js';
import { NinetailedInsightsPlugin } from '@ninetailed/experience.js-plugin-insights'

export const ninetailed = new Ninetailed(
    { 
        clientId: // Your client ID 
        environment: // Your Ninetailed environment
    }, 
    { 
        plugins: [
            new NinetailedInsightsPlugin();
        ],
        
        // Specify an amount of time (ms) that a component must be present in the viewport to register a component view
        componentViewTrackingThreshold: 2000,
    }
);

Timing Configuration

The Insights Plugin logs that a component has been seen only after the component has remained within the user's viewport for a specified amount of time (in milliseconds), determined by the value of the componentViewTrackingThreshold property on the Ninetailed instance (see code samples above). If the option is unspecified, the value defaults to 2000.