Wayfinder Insights

Overview

In SDK 3.2.0 our new advanced analytics engine and functionality was introduced which is called Wayfinder Insights. The analytics engine allows you to obtain detailed analytics on SDK usage. In addition to a name and version, it is also possible to set up to 10 custom properties to track.

Updating your config for analytics

All analytics data should be set to the config passed upon initialization. Specifically, any one or more of following keys should be included:

Key	Value
hostAppId	String, max 128 chars
hostAppVersion	String, max 128 chars
hostAppProperties	Any object with a maximum of 10 keys and 10 values. Keys and values must be strings with a max of 128 chars each. Keys may only consist of ASCII alphanumeric chars (a­z, A­Z, 0­9) and must start with an alphabetic character (if not, "X" will be prepended)

The following is an example of a config with the analytics data noted above:

JavaScript

const config = {
  venueId: 'lax',
  accountId: 'A11F4Y6SZRXH4X',
  headless: false,
  hostAppId: 'MyHostAppID',
  hostAppVersion: '1.2.3',
  hostAppProperties: {'CustomKey1':'CustomValue1', 'CustomKey2':'CustomValue2'}
}

🚧

Data Protection & Privacy

It is your responsibility to ensure that the information passed to the analytics engine using the properties noted above meets the regulatory and any other legal requirements of the region in which the data is collected.