Docs

track().screen

Suggest Edits

The track().screen() method records a screen view on your mobile app. The screen view is similar to the page view on a website.

Syntax

TrackHelper.track()
  .screen("path")
  .title("title")
  .with(tracker);

TrackHelper.track()
  .screen("path")
  .title("title")
  .with(tracker)

Parameters

path (string, required)

The path set for your screen. Example: example/welcome. The path is automatically translated into a URL and given the screen prefix if tracker.setPrefixing(true) is set.

Note: Set the current instance of the Android Activity class instead of the path if you want to use the activity stack. It’ll then automatically set the activity stack as the path and the activity title as the title.

title (string, optional)

The title set for your screen. Example: Welcome.

Examples

To send a screen view with the path example/welcome and the title Welcome:

public class activityClass extends Activity {
@Override
public void onCreate(Bundle savedInstanceState) {
  super.onCreate(savedInstanceState);
  Tracker tracker = ((PiwikApplication) getApplication()).getTracker();
  TrackHelper.track()
    .screen("example/welcome")
    .title("Welcome")
    .with(tracker);
  }
}

public class activityClass : Activity() {
  override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    val tracker: Tracker = (application as PiwikApplication).tracker
    TrackHelper.track()
      .screen("example/welcome")
      .title("Welcome")
      .with(tracker)
  }
}

To send a screen view and automatically use the activity stack as the path and the activity name as the title (if your activity class is activityClass):

public class activityClass extends Activity {
…
Tracker tracker = ((PiwikApplication) getApplication()).getTracker();
TrackHelper.track().screen(activityClass).with(tracker);
…
}

public class activityClass  : Activity() {
…
val tracker: Tracker = (application as PiwikApplication).tracker
TrackHelper.track().screen(activityClass).with(tracker)
…
}

Related methods

Updated 6 days ago