Query Parameter Tracking

Page tracking is possible with both auto-tracking enabled and disabled. When auto-tracking is disabled, only screens specifically marked for tracking are monitored.

Parameter Constants

Parameter constants are only applicable to query-based tracking. The following are available for page tracking:

Find more information here:

• How to set up categories

• How to set up custom parameters

Methods for Page Tracking

Note: Calling trackPage() or trackCustomPage() creates a new content ID. If auto-tracking is enabled, using these methods may result in multiple content IDs for the same page, which may distort your analytics. Use @TrackPageDetail or disable auto-tracking with @StopTrack or globally in  Global Configuration.

Example

Please note that custom parameters are optional in the request.

class AppActivity : AppCompatActivity() {
 
     val NEW_CATEGORY
     inline get() = customParam(ParamType.PAGE_CATEGORY, 1 )
 
     val NEW_PAGEPARAM
     inline get() = customParam(ParamType.PAGE_PARAM, 10 )
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super .onCreate(savedInstanceState)
         setContentView(R.layout.activity_details)
 
         val trackingParams = TrackingParams()
         trackingParams.putAll(
             mapOf(
                 Param.NEW_CATEGORY to "category value 1" ,
                 Param.NEW_PAGEPARAM to "parameter value 10" ,
                 Param.INTERNAL_SEARCH to "search phrase"
             )
         )
         
         // Use trackCustomPage()
         Webtrekk.getInstance().trackCustomPage( "page name" , pageParams)
 
         // Use trackPage()
         Webtrekk.getInstance().trackPage( this , "page name" , pageParams)
     }
}

public class AppActivity extends AppCompatActivity {
     
     private static final String NEW_CATEGORY = createCustomParam(ParamType.PAGE_CATEGORY, 1 ); //This will equal cg1
     
     private static final String NEW_PAGEPARAM = createCustomParam(ParamType.PAGE_PARAM, 10 ); //This will equal cp10
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super .onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
         Map<String, String> pageParams = new LinkedHashMap<>();
             pageParams.put(BACKGROUND_PARAM, "blue" );
             pageParams.put(NEW_CATEGORY, "category value 1" );
             pageParams.put(NEW_PAGEPARAM, "page param value 1" );
 
         //Use trackCustomPage
         Webtrekk.getInstance().trackCustomPage( "custom page name" , pageParams);
 
         //Use trackPage()
         Webtrekk.getInstance().trackPage( this , "custome page name" , pageParams);
     }
}

Custom Page Parameters

The following custom page parameters are predefined and are only used for page tracking:

• PAGE_PARAM("cp")

• PAGE_CATEGORY("cg")

The following custom parameters can be used for both page and event tracking:

• CAMPAIGN_PARAM("cc")

• SESSION_PARAM("cs")

• URM_CATEGORY("uc")

• ECOMMERCE_PARAM("cb")

• PRODUCT_CATEGORY("ca")

You will also find detailed information about page parameters in our Pixel References: Page Parameters.

Event or action tracking is available with both auto-tracking enabled and disabled. You can track custom events using trackCustomEvent(), which is independent of activity/fragment context.

You will find tracked events under Navigation > Events.

Parameter Constants

Parameter constants only work for query-based tracking.

If you use the custom event parameter listed above for page tracking, their values will be ignored in Analytics.

Find more information here:

• How to set up custom parameters

Methods

Example

Please note that custom parameters are optional in the request.

class AppActivity : AppCompatActivity() {
 
     val Param.NEW_EVENTPARAM
         inline get() = customParam(ParamType.EVENT_PARAM, 1 )
 
     val eventParams = TrackingParams()
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super .onCreate(savedInstanceState)
         setContentView(R.layout.activity_main)
 
         eventParams.putAll(
             mapOf(
                 Param.NEW_EVENTPARAM to "event parameter value 1"
            )
         )
 
         startNewActivity.setOnClickListener {
             val intent = Intent( this , NewActivity:: class .java)
             
             //With custom event parameters
             Webtrekk.getInstance().trackCustomEvent(eventName = "your event name" , trackingParams = eventParams)
 
             //Without custom event parameters
             Webtrekk.getInstance().trackCustomEvent(eventName = "your event name" )
             
             startActivity(intent)
         }
     }
}

public class MainActivity extends AppCompatActivity {
 
     private static final String NEW_EVENTPARAM = createCustomParam(ParamType.EVENT_PARAM, 1 ); //This will equal ck1
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super .onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
     public void goToNewActivity(){
         Intent intent = new Intent( this , NewActivity. class );
         
         Map<String, String> eventParams = new LinkedHashMap<>();
         eventParams.put(NEW_EVENTPARAM, "event parameter value 1" );
         
         //With custom event parameters
         Webtrekk.getInstance().trackCustomEvent( "your event name" , eventParams);
        
         //Without custom event parameters
         Webtrekk.getInstance().trackCustomEvent( "your event name" , Collections.emptyMap());
         startActivity(intent);
     }
}

Custom Event Parameters

The custom event parameter can only be used for event tracking:

• EVENT_PARAM("ck")

The following custom parameters can be used for both page and event tracking:

• CAMPAIGN_PARAM("cc")

• SESSION_PARAM("cs")

• URM_CATEGORY("uc")

• ECOMMERCE_PARAM("cb")

• PRODUCT_CATEGORY("ca")

You can also find detailed information about event parameters in our Pixel References: Event Parameters.

You can analyze detailed product interactions in your app. This includes tracking when products are viewed, added to the cart, and purchased. You can also analyze abandoned shopping carts and track the completion of orders with comprehensive information.

Key Information for Product and Order Tracking:

• You can add detailed information to products and orders using e-commerce parameters. Parameter constants only work for query-based tracking.

• The status of a product must be set correctly to ensure that all tracking works as expected for Mapp Intelligence e-commerce use cases.

Parameter Constants

Parameter constants only work for query-based tracking. Predefined eCommerce parameters are defined in the  ECommerceParam class, and custom parameters can be created using the ParamType class.

Example

1. Define the parameters in your app:

   KotlinJava

   val NEW_PRODUCT_CATEGORY
       inline get() = customParam(ParamType.PRODUCT_CATEGORY, 1)
   val NEW_ECOMMERCE_PARAM
       inline get() = customParam(ParamType.ECOMMERCE_PARAM, 1)
   val PRODUCT_SOLD_OUT
       inline get() = customParam(ParamType.ECOMMERCE_PARAM, 760) // Tracks if a product is sold out. Value must be 760 to use the correct pre-defined parameter

   private static final String NEW_PRODUCT_CATEGORY = createCustomParam(ParamType.PRODUCT_CATEGORY, 1);
   private static final String NEW_ECOMMERCE_PARAM = createCustomParam(ParamType.ECOMMERCE_PARAM, 1);
   private static final String PRODUCT_SOLD_OUT = createCustomParam(ParamType.ECOMMERCE_PARAM, 760); // Tracks if a product is sold out. Value must be 760 to use the correct pre-defined parameter

2. Track the desired products as viewed in your app:

   KotlinJava

   val productParams: MutableMap<String, String> = LinkedHashMap()
       productParams[PRODUCT_NAME] = "productId"
       productParams[STATUS_OF_SHOPPING_CARD] = "view"
       productParams[PRODUCT_COST] = "product cost"
       productParams[PRODUCT_CURRENCY] = "gbp"
       productParams[NEW_PRODUCT_CATEGORY] = "category productID"
       productParams[NEW_ECOMMERCE_PARAM] = "ecommerce param productID"
       productParams[PRODUCT_QUANTITY] = "quantity of product"
       productParams[PRODUCT_SOLD_OUT] = "1" //1 = product sold out, 0 = product available
    
   Webtrekk.getInstance().trackCustomPage("page name", productParams)

   Map<String, String> productParams = new LinkedHashMap<>();
       productParams.put(PRODUCT_NAME, "productId");
       productParams.put(STATUS_OF_SHOPPING_CARD, "view");
       productParams.put(PRODUCT_COST, "product cost");
       productParams.put(Param.PRODUCT_CURRENCY, "gbp");
       productParams.put(NEW_PRODUCT_CATEGORY, "category productID");
       productParams.put(NEW_ECOMMERCE_PARAM, "ecommerce param productID");
       productParams.put(PRODUCT_QUANTITY, "quantity of product");
       productParams.put(PRODUCT_SOLD_OUT, "1"); //1 = product sold out, 0 = product available
    
   Webtrekk.getInstance().trackCustomPage("page name", productParams);

3. Track add to cart status by changing  STATUS_OF_SHOPPING_CARD to "add":

   KotlinJava

   val productParams: MutableMap<String, String> = LinkedHashMap()
       productParams[PRODUCT_NAME] = "productId"
       productParams[STATUS_OF_SHOPPING_CARD] = "add"
       productParams[PRODUCT_COST] = "product cost"
       productParams[PRODUCT_CURRENCY] = "gbp"
       productParams[NEW_PRODUCT_CATEGORY] = "category productID"
       productParams[NEW_ECOMMERCE_PARAM] = "ecommerce param productID"
       productParams[PRODUCT_QUANTITY] = "quantity of product"
    
   Webtrekk.getInstance().trackCustomPage("page name", productParams)

   Map<String, String> productParams = new LinkedHashMap<>();
       productParams.put(PRODUCT_NAME, "productID");
       productParams.put(STATUS_OF_SHOPPING_CARD, "add");
       productParams.put(PRODUCT_COST, "product cost");
       productParams.put(Param.PRODUCT_CURRENCY, "gbp");
       productParams.put(NEW_PRODUCT_CATEGORY, "category productID");
       productParams.put(NEW_ECOMMERCE_PARAM, "ecommerce param productID");
       productParams.put(PRODUCT_QUANTITY, "quantity of product");
    
   Webtrekk.getInstance().trackCustomPage("page name", productParams);

4. Track order confirmation by changing STATUS_OF_SHOPPING_CARD to "conf" and add order information:

   KotlinJava

   val productParams: MutableMap<String, String> = LinkedHashMap()
   productParams[PRODUCT_NAME] = "productId1;productId2;productIdN"
   productParams[STATUS_OF_SHOPPING_CARD] = "conf"
   productParams[PRODUCT_COST] = "cost productID1; cost productId2; cost productIdN"
   productParams[PRODUCT_CURRENCY] = "gbp"
   productParams[NEW_PRODUCT_CATEGORY] = "category productId1;;category productIdN"
   productParams[NEW_ECOMMERCE_PARAM] = "ecommerce param productId1;ecommerce productId2;"
   productParams[PRODUCT_QUANTITY] = "number productId1;number productId2;number productIdN"
   productParams[PRODUCT_SOLD_OUT] = "1" //1 = product sold out, 0 = product available
   productParams[ORDER_ID] = "order ID"
   productParams[ORDER_VALUE] = "total order value"
   
   Webtrekk.getInstance().trackCustomPage("order conf pagename", productParams)
   

   Map<String, String> productParams = new LinkedHashMap<>();
       productParams.put(PRODUCT_NAME, "productId1;productId2;productIdN");
       productParams.put(STATUS_OF_SHOPPING_CARD, "conf");
       productParams.put(PRODUCT_COST, "cost productId1; cost productId2; cost productIdN");
       productParams.put(Param.PRODUCT_CURRENCY, "gbp");
       productParams.put(NEW_PRODUCT_CATEGORY, "category productId1;;category productIdN");
       productParams.put(NEW_ECOMMERCE_PARAM, "ecommerce param productId1;ecommerce productId2;");
       productParams.put(PRODUCT_QUANTITY, "number productId1;number productId2;number productIdN");
       productParams.put(ORDER_ID, "your order ID");
       productParams.put(ORDER_VALUE, "total order value");
    
   Webtrekk.getInstance().trackCustomPage("order conf page name", productParams);

   Please note that when adding multiple products to one order, you need to separate the values for each product via a semicolon (;) in the correct order to correctly analyze it in Intelligence.

You can track goal achievements using page or event requests in Mapp Intelligence, allowing you to evaluate which campaigns led to conversions. Learn more about how to define goals in Mapp Q3 here.
Further information about the analysis and use of website goals in Mapp Intelligence can be found in the training chapter Analysis of Goal Achievement.

Parameter Constants

Parameter constants only work for query-based tracking.

Example

class AppActivity : AppCompatActivity() {
 
     val Param.NEW_GOAL
     inline get() = customParam(ParamType.ECOMMERCE_PARAM, 1 )
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super .onCreate(savedInstanceState)
         setContentView(R.layout.activity_details)
 
         val trackingParams = TrackingParams()
         trackingParams.putAll(
             mapOf(
                 Param.NEW_GOAL to "goal value 1"
             )
         )
         
         // Track as page without context
         Webtrekk.getInstance().trackCustomPage( "page name" , trackingParams)
 
         // Track as page with context
         Webtrekk.getInstance().trackPage( this , "page name" , trackingParams)
 
         //Track as event
         startNewActivity.setOnClickListener {
             val intent = Intent( this , NewActivity:: class .java)
 
             Webtrekk.getInstance().trackCustomEvent(eventName = "your event name" , trackingParams = trackingParams)
 
             startActivity(intent)
         }
     }
}

public class AppActivity extends AppCompatActivity {
     
     private static final String NEW_GOAL = createCustomParam(ParamType.ECOMMERCE_PARAM, 1 ); //This will equal cb1
 
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super .onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
 
         Map<String, String> trackingParams = new LinkedHashMap<>();
             trackingParams.put(NEW_GOAL, "goal value 1" );
 
         //Track as page without context
         Webtrekk.getInstance().trackCustomPage( "custom page name" , trackingParams);
 
         //Track as page with context
         Webtrekk.getInstance().trackPage( this , "custome page name" , trackingParams);
 
         //Track as event step1
         Button button = findViewById(R.id.button);
         button.setOnClickListener ( new View.OnClickListener(){
             @Override
             public void onClick(View v){
                 goToNextActivity();
             }
         });
     
         //Track as event step2
         public void goToNextActivity(){
            Intent intent = new Intent( this , NextActivity. class );
            Map<String, String> trackingParams = new LinkedHashMap<>();
             trackingParams.put(NEW_GOAL, "goal value 1" );
             Webtrekk.getInstance().trackCustomEvent( "your event name" , trackingParams);
             startActivity(intent);
         }  
     }
}

If you get errors, be sure to check that you imported the necessary libraries:

import webtrekk.android.sdk.ParamType;
import webtrekk.android.sdk.Webtrekk;
import static webtrekk.android.sdk.ParamTypeKt.createCustomParam;

Campaign tracking allows you to track the effectiveness of marketing campaigns. This is configured in Mapp Q3 (Configuration > Marketing Configuration).

Further information about campaigns can be found in the training chapter Campaign Configuration.

Campaigns can be tracked in both page and event requests.

Parameter Constants

Parameter constants only work for query-based tracking. Predefined campaign parameters are defined in the  CampaignParam class, and custom parameters can be created using the ParamType class.

For deep link campaigns, please check the dedicated use case description.

You can enrich sessions with additional parameters. Depending on the settings in your account, the first or last value of the parameter will be used for analyses.

Session parameters can be tracked in both page and event requests.

Parameter Constants

Parameter constants are only available for query-based tracking.

Predefined Session Parameter

Some session parameters can be preconfigured, including App version, App updated, and App first open. These parameters can be activated without needing to be defined in your mobile app, simplifying session tracking.

The following parameters are predefined in the SDK:

To configure the session parameter, proceed as follows:

1. Log in to your Mapp Q3 account.

2. Go to Configuration > Custom Parameters > Session parameters

3. Then click Create a new custom parameter. The specification dialog for the session parameter opens.

4. Make the following configuration:

   Parameter	Description
   Title	Mandatory. Enter the name of the session parameter.
   Description	Optional. Enter a description for the session parameter.
   Active	Select via the radio button whether the session parameter is active or inactive. When disabled, no data is collected.
   Preconfigured	Under "Preconfigured," select one of the following parameters: App updated App version App first open Preset settings apply automatically.
   Parameter ID	The ID is set automatically by the system.

5. Click Save to save your settings.

User tracking allows you to categorize users to improve analyses in Mapp Intelligence. You can transmit both pre-defined and custom categories for each user.

User data can be tracked in both page and event requests.

Recommendation

Transmit hashed personal data should not be evaluated in terms of content (e.g. with the SHA256 hash). If you would like to collect this data for analytical reasons, we suggest that you transmit the data in encrypted form (see How to Implement Server-Side Encryption in Mapp Intelligence).

Parameter Constants

Parameter constants are only available for query-based tracking. Predefined customer parameters are defined in the  UserCategoriesParam class, and custom parameters can be created using the  ParamType class.

Form tracking is available in native Android applications from SDK version 5.0.1.

This feature allows customers to capture detailed user input on forms, tracking whether each form field is filled out or left empty.

Trackable Field Types

You can track user input for the following field types:

• EditText

  • Plain

  • Multiline

  • AutoComplete

  • MultiAutoComplete

  • Email

  • Address

  • Phone

  • Password

  • Number

• Time

• Date

• SearchView

• RadioButton

• ToggleButton

• Switch

• CheckBox

• RatingBar

• Spinner

Methods and Properties

Name of Function

formTracking(
        context: Context,
        view: View? = null,
        formTrackingSettings: FormTrackingSettings = FormTrackingSettings()
    )

Configuration

• formName: Specify a name for the form (default: activity/view name).

• fieldIds: Specify field IDs to track only certain fields (default: all fields are tracked)

• renameFields: Change the default field name (default: the name of the field ID)

• changeFieldsValue: Override the default field value (if hardcoded, the field always reflects this value).

• anonymousSpecificFields: Anonymize specific fields (default: only EditText fields are anonymized).

• fullContentSpecificFields: Send the actual content of specified fields (default: EditText fields are anonymized).

• confirmButton: Marks form submission(submitted or canceled) (default: true).

• anonymous: Anonymizes all field types if set to true.

• pathAnalysis: You can track the order in which the user has filled out the fields. Please note that you need to track the order manually and parse the data using the fieldsOrder function. Mapp Intelligence cannot track the order in which the user fills out the form automatically.

data class FormTrackingSettings(
    var formName: String = "",
    var fieldIds: List<Int> = emptyList(),
    var renameFields: Map<Int, String> = emptyMap(),
    var changeFieldsValue: Map<Int, String> = emptyMap(),
    var anonymousSpecificFields: List<Int> = emptyList(),
    var fullContentSpecificFields: List<Int> = emptyList(),
    var confirmButton: Boolean = true,
    var anonymous: Boolean = true,
    var pathAnalysis: List<Int> = emptyList()
)

Example

// set form tracking config for confirmation and cancellation of form
class FormActivity : AppCompatActivity(), AdapterView.OnItemSelectedListener {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.form_main)
 
        //Set a listener on the cancel button of a form
        cancel.setOnClickListener {
            val form = FormTrackingSettings()
            form.confirmButton = false //confirm button is
            form.formName = "test123"
            form.anonymous = true
            form.anonymousSpecificFields = listOf(R.id.editText, R.id.editText3, R.id.switch1)
            form.fullContentSpecificFields = listOf(R.id.editText2)
            Webtrekk.getInstance().formTracking(this, formTrackingSettings = form)
        }
 
        //Set a listener on the confirm button of a form
        confirm.setOnClickListener {
            val form = FormTrackingSettings()
            form.confirmButton = true
            form.formName = "test123"
            form.anonymous = true
            form.anonymousSpecificFields = listOf(R.id.editText2)
            form.fullContentSpecificFields = listOf(R.id.editText, R.id.editText3, R.id.switch1)
            Webtrekk.getInstance().formTracking(this, formTrackingSettings = form)
        }
    }
}
 
// configure specific view
val view =
    findViewById<View>(android.R.id.content).rootView
Webtrekk.getInstance().formTracking(this,view=view)
 
// configure form name
val form= FormTrackingSettings()
form.formName="My Form"
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// congfigure to track only specific fields
val form= FormTrackingSettings()
form.fieldsOrder= listOf(R.id.editText2,R.id.editText)
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// rename fields
val form= FormTrackingSettings()
form.renameFields=mapOf(Pair(R.id.editText2,"Named text view"))
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// anonymise specific fields
val form= FormTrackingSettings()
form.anonymousSpecificFields=listOf(R.id.switch1)
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// anonymise all fields
val form= FormTrackingSettings()
form.anonymous=true
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// show full content of specific fields
val form= FormTrackingSettings()
form.fullContentSpecificFields=listOf(R.id.editText1)
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// change value of fields
val form= FormTrackingSettings()
form.changeFieldsValue=mapOf(Pair(R.id.editText2,"New value")) // this needs to be filled dynamically!
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// set confirm button to false
val form= FormTrackingSettings()
form.confirmButton=false
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)
 
// track path analysis
val form= FormTrackingSettings()
form.pathAnalysis= listOf(R.id.editText2,R.id.editText,R.id.editText3) //this needs to be filled dynamically!
Webtrekk.getInstance().formTracking(this,formTrackingSettings=form)

// set form tracking config for confirmation and cancellation of form
public class FormActivity extends AppCompatActivity implements AdapterView.OnItemSelectedListener {
    private Button cancel;
    private Button confirm;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.form_main);
         
        //Set a listener on the cancel button of a field
        cancel = findViewById(R.id.cancel);
        cancel.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                FormTrackingSettings form = new FormTrackingSettings();
                form.setConfirmButton(false);
                form.setFormName("test123");
                form.setAnonymous(true);
                form.setAnonymousSpecificFields(Arrays.asList(R.id.editText, R.id.editText3, R.id.switch1));
                form.setFullContentSpecificFields(Arrays.asList(R.id.editText2));
                Webtrekk.getInstance().formTracking(FormActivity.this, null, form);
            }
        });
 
        //Set a listener to the confirm button of a field
        confirm = findViewById(R.id.confirm);
        confirm.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                FormTrackingSettings form = new FormTrackingSettings();
                form.setConfirmButton(true);
                form.setFormName("test123");
                form.setAnonymous(false);
                form.setAnonymousSpecificFields(Arrays.asList(R.id.editText2));
                form.setFullContentSpecificFields(Arrays.asList(R.id.editText, R.id.editText3, R.id.switch1));
                Webtrekk.getInstance().formTracking(FormActivity.this, null, form);
            }
        });
    }
}
 
         
// Configure specific view
View view = findViewById(android.R.id.content).getRootView();
Webtrekk.getInstance().formTracking(this, view, new FormTrackingSettings());
 
// Configure form name
FormTrackingSettings form = new FormTrackingSettings();
form.setFormName("My Form");
Webtrekk.getInstance().formTracking(this, null, formOne);
 
// Configure to track only specific fields
FormTrackingSettings form = new FormTrackingSettings();
form.setFieldIds(Arrays.asList(R.id.editText2, R.id.editText));
Webtrekk.getInstance().formTracking(this, null, formTwo);
 
// Rename fields
FormTrackingSettings form = new FormTrackingSettings();
form.setRenameFields(new LinkedHashMap<Integer, String>() {{
    put(R.id.editText2, "Named text view");
}});
Webtrekk.getInstance().formTracking(this, null, formThree);
 
// Anonymize specific fields
FormTrackingSettings form = new FormTrackingSettings();
form.setAnonymousSpecificFields(Arrays.asList(R.id.switch1));
Webtrekk.getInstance().formTracking(this, null, formFour);
 
// Anonymize all fields
FormTrackingSettings form = new FormTrackingSettings();
form.setAnonymous(true);
Webtrekk.getInstance().formTracking(this, null, formFive);
 
// Show full content of specific fields
FormTrackingSettings form = new FormTrackingSettings();
form.setFullContentSpecificFields(Arrays.asList(R.id.editText));
Webtrekk.getInstance().formTracking(this, null, formSix);
 
// Change value of fields
FormTrackingSettings form = new FormTrackingSettings();
form.setChangeFieldsValue( new LinkedHashMap<Integer, String>() {{
    put(R.id.editText2, "New Value");
}}); // this needs to be filled dynamically!
Webtrekk.getInstance().formTracking(this, null, formSeven);
 
// Set confirm button to false
FormTrackingSettings form = new FormTrackingSettings();
form.setConfirmButton(false);
Webtrekk.getInstance().formTracking(this, null, formEight);
 
// Track path analysis
FormTrackingSettings form = new FormTrackingSettings();
form.setPathAnalysis(Arrays.asList(R.id.editText2,R.id.editText,R.id.editText3)); //this needs to be filled dynamically!
Webtrekk.getInstance().formTracking(this, null, formNine);

Additional Resources

Please also check our sample application inside our Android SDK v5 version to try out form tracking in a sample app. You can download the SDK from GitHub.

Known Limitations

• Last Focus does not work faultlessly and only for editText types.

• pathAnalysis and rename fields do not work automatically.

The Media Tracking API allows you to track user interactions with media files, such as videos or audio, in your app. You can track events such as media play, pause, seek actions, and more. Media tracking provides insights into how users engage with your media content, including metrics like duration watched, position within the media, and interaction frequency.

You will find tracked media under Navigation > Media > Media.

Parameter Constants

Parameter constants can only be used in query-based tracking.

Methods

trackMedia(
    mediaName: String, 
    trackingParams: Map<String, 
    String> = emptyMap()
)

Example

// Step: Track media initialization (init action)
val trackingParams = mutableMapOf(
    MediaParam.MEDIA_DURATION to "300",
    MediaParam.MEDIA_POSITION to "0",
    MediaParam.MEDIA_ACTION to "init"
)
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Step: Track media play
trackingParams[MediaParam.MEDIA_ACTION] = "play"
trackingParams[MediaParam.MEDIA_POSITION] = "30"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Step: Track media seek
trackingParams[MediaParam.MEDIA_ACTION] = "seek"
trackingParams[MediaParam.MEDIA_POSITION] = "60"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

constructor(context: Context?) : super (context) {
         initMediaFile()
     }
 
fun initMediaFile() {
         trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_DURATION to duration.toString(),
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "init"
             
             )
         )
      Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
     }
 
     override fun pause() {
         super .pause()
         trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "pause"
             )
         )
         Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
     }
 
     override fun start() {
         super .start()
         trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "play"
             )
         )
         Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
 
     }
 
     override fun stopPlayback() {
         super .stopPlayback()
         trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "stop"
             )
         )
         Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
     }
 
     override fun seekTo(msec: Int) {
         trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "seek"
             )
         )
         Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
        super .seekTo(msec)
        trackingParams.putAll(
             mapOf(
                 MediaParam.MEDIA_POSITION to (currentPosition / 1000 ).toString(),
                 MediaParam.MEDIA_ACTION to "pause" // can be pause or play
             )
         )
         Webtrekk.getInstance().trackMedia( "video name" , trackingParams)
     }

Map<String, String> trackingParams = new HashMap<>();

// Step 1: Track media initialization
trackingParams.put(MediaParam.MEDIA_DURATION, String.valueOf(duration / 1000));
trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000));
trackingParams.put(MediaParam.MEDIA_ACTION, "init");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Step 2: Track media stop
trackingParams.put(MediaParam.MEDIA_DURATION, String.valueOf(duration / 1000));
trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000));
trackingParams.put(MediaParam.MEDIA_ACTION, "stop");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Step 3: Track media seek
trackingParams.put(MediaParam.MEDIA_DURATION, String.valueOf(duration / 1000));
trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000));
trackingParams.put(MediaParam.MEDIA_ACTION, "seek");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

public TrackedVideoView( @Nullable Context context) {
     super (context);
     this .initMediaFile();
  }
 
  public void initMediaFile() {
    Map<String, String> trackingParams = new HashMap<>();
       trackingParams.put(MediaParam.MEDIA_DURATION, String.valueOf(duration / 1000 ));
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "init" );
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
   }
  @Override
  public void  pause() {
       super .pause()
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "pause" );
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
   }
   @Override
   public void  start() {
       super .start()
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "play" );
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
 
   }
@Override
public void  stopPlayback() {
       super .stopPlayback()
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "stop" );
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
  
   }
  @Override
  public void seekTo(msec: Int) {
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "seek" );
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
      super .seekTo(msec)
       trackingParams.put(MediaParam.MEDIA_POSITION, String.valueOf(currentPosition / 1000 ));
       trackingParams.put(MediaParam.MEDIA_ACTION, "pause" ); // can be pause or play
       Webtrekk.getInstance().trackMedia( "video name" , trackingParams);
     
   }

API Constraints: Start a media session

• Start a Media Session: The session must start with an init or play action.

• Seek Action: When seeking, the position at the start of the seek action should be sent, followed by either play or pause after seeking is complete.

Example 1: Media Seek with Continuous Play

A user is watching a video and seeks from 8 seconds to 20 seconds, continuing playback.

Kotlin:

// Start with play at position 8 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "play"
trackingParams[MediaParam.MEDIA_POSITION] = "8"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Seek to 20 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "seek"
trackingParams[MediaParam.MEDIA_POSITION] = "8"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Continue playing from 20 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "play"
trackingParams[MediaParam.MEDIA_POSITION] = "20"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

Java:

// Start with play at position 8 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "play");
trackingParams.put(MediaParam.MEDIA_POSITION, "8");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Seek to 20 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "seek");
trackingParams.put(MediaParam.MEDIA_POSITION, "8");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Continue playing from 20 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "play");
trackingParams.put(MediaParam.MEDIA_POSITION, "20");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

Please note that Exo2Player changes a state to pause automatically after each seeks. You need to manually suppress that to be aligned with the API expectation.

Example 2: Media Seek with Pause

The user pauses the video at 8 seconds, seeks to 20 seconds, and the video remains paused.

Kotlin:

// Pause at 8 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "pause"
trackingParams[MediaParam.MEDIA_POSITION] = "8"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Seek to 20 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "seek"
trackingParams[MediaParam.MEDIA_POSITION] = "8"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

// Stay paused at 20 seconds
trackingParams[MediaParam.MEDIA_ACTION] = "pause"
trackingParams[MediaParam.MEDIA_POSITION] = "20"
Webtrekk.getInstance().trackMedia("football123", trackingParams)

Java:

// Pause at 8 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "pause");
trackingParams.put(MediaParam.MEDIA_POSITION, "8");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Seek to 20 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "seek");
trackingParams.put(MediaParam.MEDIA_POSITION, "8");
Webtrekk.getInstance().trackMedia("football123", trackingParams);

// Stay paused at 20 seconds
trackingParams.put(MediaParam.MEDIA_ACTION, "pause");
trackingParams.put(MediaParam.MEDIA_POSITION, "20");
Webtrekk.getInstance().trackMedia("football123", trackingParams);