Send Segments from Maestro Applications

   Journey Analytics The behavioural analytics tool.  |   Analytics User |  All versions This feature is related to all versions.


Segmentation analysis is a powerful tool that helps you to understand the behavior of specific groups of users who share a common trait. It allows you to slice and dice Insights data to provide more granularity and identify usability issues that may impact onboarding performance for specific groups of users. In short, you can identify "what group of users" abandon the application, and "at what stage" of the journey. This capability helps businesses increase ROI by focusing investments on optimizing journeys for specific groups of users.

Segmentation analysis is powered by segment events data sent to Journey Analytics. Segments are custom events that can be sent via Segment APIs from a supported application or from a groovy/fluent service on Journey Manager, to Journey Analytics. Each segment event lets Journey Analyticsknow to which segment a transaction belongs to. A transaction can only belong to one segment or group. For instance, transactions can be grouped by gender, age or age brackets, products selected, or Exchange package used to complete an application, such as LinkedIn prefill or Mitek drivers license scan.

It is important to make sure each segment name and value sent as part of the segment event do not contain any PII (data that could identify an individual user, such as an address, telephone number or account number). For more information on PII, see Data Privacy and Security.

As a safeguard against unintentionally sent personally identifiable information (PII), a segment whitelisting mechanism has been introduced to Journey Analytics. No segments are stored in Journey Analytics unless they have been whitelisted under Preferences > Whitelist segments first. For more information on the Segment Whitelist, see Preferences

To send a segment from a Maestro application use the following Maestro Segment API:

Insights.segment("name of segment", "value");

Segment compatibility

  • Maestro - From 5.1.x.


Below is an example of adding age segmentation using a Change Rule on the year of birth field in the Maestro form. The corresponding Segment Whitelist is also shown as no segmentation data is stored in Journey Analytics unless it has been added to the Segment Whitelist first.

For Journey Analytics to store these segment names and values they need to be added to the Segment Whitelist as shown below.

The Segment Whitelist is shared across all Journey Manager environments (DEV, UAT, TEST, STAGING, PROD). Changes to the Segment Whitelist in one environment will be reflected in all environments.