Track events

Events represent things people do in your app, website, etc, so that you can track your audience’s activity and metrics. Use events to segment your audience, trigger campaigns, and capture usage metrics in your app.

This page is part of a setup flow for the SDK. Before you continue, make sure you've implemented previous features—i.e. you can't identify people before you initialize the SDK!

graph LR getting-started(Install SDK) -->B(Initialize SDK) B --> identify(identify people) identify -.-> track-events(Send events) identify -.-> push(Receive push) identify -.-> rich-push(Receive Rich Push) track-events --> test-support(Write tests) push --> test-support rich-push --> test-support click getting-started href "/docs/sdk/android/getting-started" click B href "/docs/sdk/android/getting-started/#initialize-the-sdk" click identify href "/docs/sdk/android/identify" click track-events href "/docs/sdk/android/track-events/" click register-token href "/docs/sdk/android/push" click push href "/docs/sdk/android/push" click rich-push href "/docs/sdk/android/rich-push" click in-app href "/docs/sdk/android/in-app" click test-support href "/docs/sdk/android/test-support" style track-events fill:#B5FFEF,stroke:#007069

Track a custom event

After you identify a person, you can use the track method to send events representing their activities to When you send events, you can include event data—information about the person or the event that they performed.

In, you can use events to trigger campaigns and broadcasts. Those campaigns might send someone a push notification or manipulate information associated with the person in your workspace. You can reference the data in your event to segmentA segment is a group of people in your audience that you want to target with campaigns, messages, etc. You can join groups of people manually, or by attribues and event data. members of your audience or as variables in your messages using liquidA syntax that supports variables, letting you personalize messages for your audience. For example, if you want to reference a person’s first name, you might use the variable {{customer.first_name}}..

Events include the following:

  name = "purchase",
  attributes = mapOf("product" to "socks", "price" to "4.99")

 Check out our sample app!

Our Remote Habits app, provides a real-world example and can act as a template to help you implement the SDK.

Screen view events

Screen views are events that record the pages that your audience visits in your app. They have a type property set to screen, and a name representing the title of the screen or page that a person visited in your app.

Screen view events let you trigger campaignsA series of actions that you perform for each person who matches criteria. Campaigns typically send people a series of messages, but you can also use campaigns to send webhooks, update attributes, etc. or add people to segmentsA group of people who match a series of conditions. People enter and exit the segment automatically when they match or stop matching conditions. based on the parts of your app your audience uses. Screen view events also update your audience’s “Last Visited” attribute, which can help you track how recently people used your app.

Enable automatic screen tracking

When you enable automatic screen tracking, the SDK sends an event every time a person visits a screen in your app. You can turn on automatic screen tracking by appending autoTrackScreenViews(true) to CustomerIO.Builder.

When automatically tracking screen events, we capture the name of the screen with the following priority from highest to lowest:

  1. We check if the current Activity has a label in the manifest file. If it does, the SDK will use the value for label.
  2. We get the class name of the Activity and use that value.

The SDK will take whatever value it receives and will strip the word Activity from it. Example: If you have an Activity with the manifest label or class name ProfileActivity, the SDK will track the screen view with the name Profile.

  siteId = "your-site-id",
  apiKey = "your-api-key",
  appContext = this

If you want to send more data with screen events, or you don’t want to send events for every individual screen that people view in your app, you can send screen events manually.

Send your own screen events

Screen events use the .screen method. Like other events, you can add a map of attributes object containing additional information about the screen event or the currently-identified person.

  name = "baseballDailyScores",
  attributes = mapOf("prevScreen" to "homescreen", "secondsInApp" to "120")
Copied to clipboard!
Latest release
Is this page helpful?