Segment Plugin
Send Ninetailed Experience views as Twilio Segment `track` events.
Segment is a powerful customer data orchestration tool. This plugin allows you to send experience views to a Segment as track events via a connected Analytics.js source.
Looking to send data from Segment to Ninetailed instead? Check out the Customer Data documentation.
Installation
Install the dependency:
Then, add the plugin to the Ninetailed instance:
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
.
Default Data Layer Properties
Events sent from this plugin are named nt_experience
. They are sent with five default parameters:
Parameters | Value Type | Value Description |
---|---|---|
ninetailed_experience | String | Experience ID of the experience |
ninetailed_experience_name | String | Title of the experience entry from the CMS |
ninetailed_variant | String | "control", "variant 1", "variant 2", … |
ninetailed_audience | String | CMS entry ID of the audience |
ninetailed_component | String | CMS entry ID of the shown variant |
Custom Event Properties
You can also define your own variables to push to Segment by passing in a configuration object when instantiating the plugin. To do so, define a config object with a template
property whose value is an object consisting of key-value pairs, where the key is the name of the property you want to add to the Segment track event and the value is a string of the desired variable value surrounded by double curly braces ({{ }}
).
Available Properties
Property | Notes |
---|---|
experience.id | |
experience.type |
|
experience.name | |
experience.description | |
audience.id |
|
audience.name |
|
audience.description | |
selectedVariant | |
selectedVariant.YOUR_PROP | Specify any property key from the selected experience variant |
selectedVariantIndex | 0, 1, 2, etc. |
selectedVariantSelector | "control", "variant 1", "variant 2", etc. This is a mapping of |
Example Custom Use
This example shows passing the human-readable name of an audience to a custom event property titled ninetailed_audience_name
. The default event properties are also pushed.
Last updated