The best place to setup the SDK is in onCreate() method of your Application class:

The easiest way of setting up the SDK is with setupAndStartRecording() method:

It will set the SDK up and also start the recording. SDK can be setup without starting the recording using:

Some recording parameters can be configured on setup:

Reset session

Current session can be ended and new session created by calling:

If resetUser is set to true SDK will create new visitor during the reset. This is especially beneficial when new user needs to be identified (typically after logout).

New session can be created on SDK setup:

New visitor can also be created on SDK setup:

When using native rendering mode, SDK can record sensitive data in your application. Recording can be configured with methods listed below so sensitive data is not recorded, or Wireframe rendering mode can be set beacause it does not record sensitive data by design.

Blacklisted views

Any view can be hidden in the recording by marking it as a blacklisted view. View can be marked as blacklisted by calling:

Or can be tagged directly in xml layout file:

If view no longer needs to be blacklisted:

Blacklisted classes

Sometimes it can be beneficial to blacklist all instances of given Class that extends View rather than blacklisting specific View instances:

Any of blacklisted classes can be removed:

Whitelisted views

View can be whitelisted so it is recorded even if it is instance of a blacklisted class:

Or it can be tagged as whitelisted directly in xml layout file:

View can be removed from whitelist by calling:

WebView blacklisting/whitelisting

When application has some parts displayed using WebView and theese parts should be recorded WebView recording needs to be enabled by removing WebView from list of blacklisted classes:

If WebView is being recorded all sensitive elements on the displayed web page should be marked as sensitive so the are are hidden. This can be done by marking sensitive html elements with .smartlook-hide css class:

<div class='smartlook-hide'>
   This will be hidden.
</div>

All input inputs are hidden by default except for button and submit types. If some hidden inputs should to be recorded they can be marked with .smartlook-show css class:

<input type="text" class='smartlook-show'>

Additional user information such as name, email, etc. can be set using UserProperties helper class and its methods.

If there is no suitable helper method for specific properties, put() method can be used. This method accepts combination of key and value.

All helper and put() method have optional parameter immutable if set to true, the value that has been set for the key is going to be immutable. This means it cannot be set again (new value will not overrride the old one).

Some analytic events are recorded out-of-box:

• Activity/Fragment changes
• Focus changes
• Clicked views
• Application crashes
• For everything else custom events can be used.

Additional data serialized as JSONObject, Bundle, String with valid json format or key/value pair can be added to custom event:

where viewState can be either ViewState.START or ViewState.STOP.

It can be explicitly specified if the navigation event happened between Activities or Fragments:

where viewType is one of ViewType.ACTIVITY or ViewType.FRAGMENT.

In this case duration_event will have duration property set to circa 1000ms.

Customize automatic event detection

For some automatically detected events SDK tries to figure out the name from application context:

• click event - Event name consists of Activity name, View class (Button, etc.) and id.
• navigation event - Event name is set as Activity/Fragment name.

But sometimes it's impossible to name an event with an easy to read and descriptive name. Because of this SDK provides an option to personalize event names.

Name click events

So a detected click on a given view has a custom event name instead of id it can be tagged directly in the XML layout file:

Name navigation events

Custom names for navigation events can be set in two different ways. Activity/Fragment can implement SmartlookNamedController interface:

Or Activity/Fragment root view can be tagged directly in XML layout file:

It can be beneficial to disable some automatically detected events due to security or usability reasons. This can be done using event tracking modes:

• FULL_TRACKING this a default state. SDK tracks all automatically detected events along with all user defined events.
• IGNORE_USER_INTERACTION disables automatically detected selector (click on a View), focus, touch, gesture and keyboard events.
• IGNORE_NAVIGATION_INTERACTION disables automatically detected navigation events. User defined ones are still being sent.
• IGNORE_RAGE_CLICKS disables automatic detection and tracking of rage click events.
• NO_TRACKING no automatically detected events are tracked. Only user defined events are still tracked.

Setup with event tracking modes

Single or combination of event tracking modes can be set right at the SDK setup:

Set event tracking modes

Single or combination of event tracking modes can be set any time after SDK setup using:

List event tracking modes

All currently active event tracking modes can be listed by calling:

SDK can use different methods of capturing screen image data. These are called rendering modes.

Set rendering mode

Rendering mode can be changed on SDK setup using builder:

Or at anytime during application run using:

Rendering modes available:

• RenderingMode.NATIVE
• RenderingMode.WIREFRAME
• RenderingMode.NO_RENDERING

Current rendering mode

Currently active rendering mode can be obtained by calling:

Set rendering mode option

WIREFRAME rendering mode can be further configured by renderingModeOption.

Rendering mode option can be set on setup:

Or at anytime during application run using:

Rendering mode options for WIREFRAME rendering mode:

• RenderingMode.WIREFRAME
• RenderingMode.BLUEPRINT
• RenderingMode.ICON_BLUEPRINT

Current rendering mode option

Currently active rendering mode option can be obtained by calling:

Network intercepting

Applications HTTP traffic can be tracked using the network inceptor provided by the SDK. This feature is available is curently available only for OkHttp HTTP/REST communication library.

OkHttp interceptor

Smartlook interceptor can be added as a another NetworkInterceptor when creating a OkHttpClient like this:

Smartlook SDK will not read or send out any body data, it is reading and sending only these request metadata:

• Request url that can be stripped of any sensitive data -> read more.
• Http method used for this request.
• Request headers that can be filtered out so they do not leak any sensitive data.
• Response headers that are filtered out so they do not leak any sensitive data.
• Protocol negotiated by this connection.
• Duration between request and response/failure.
• Request status stating if the request was successful or eventually how it failed, can be one of:
  • Ok
  • Error
  • Abort
  • Timeout
• Status code of http response.
• Flag stating if response was received from cache.

Url masks

Sensitive parts of request URLs can be hidden using UrlMask:

UrlMasks can be added using SmartlookOkHttpInterceptor.Builder:

Sensitive headers

Intercepted headers can contain sensitive data, so they need to be filtered out by their name. This can be done using sensitiveHeaderNameRegexps, this list of sensitive header names contains these regular expressions by default:

• ".*csrf.*"
• ".*token.*"
• ".*auth.*"
• ".*key.*"
• ".*cookie.*"

Custom list of sensitive header name regular expressions can be defined:

Instal referrer

When application is installed from the Google Play Store Smartlook SDK automatically tracks install referrer.

Custom referrer can be also set using:

Smartlook can be manualy integrated info various analytic frameworks using our IntegrationListener.

Listener can be registered like this:

Listener can be simply unregistered:

Automatic integrations provide simple way of integrating Smartlook into various 3rd party analytic tools.

Enable integrations

One or list of automatic integrations can be enabled by calling:

Specific Integrations are described in Integrations documentation:

• Amplitude
• Mixpanel
• Heap
• Firebase Crashlytics
• Bugsnag

Disable integrations

Every currently enabled Integration can be disabled:

Or all currently enabled integrations can be disabled using:

List integrations

All currently enabled integrations can be listed: