Overview

Events track what individual actions users perform in your app or website. Some examples of events include a user launching an app, viewing a product, listening to a song, sharing a photo, making a purchase, or favoriting an item.

By tracking events in your app, you can better understand what users are doing. In CleverTap, you can analyze these events in many different ways, such as getting aggregating metrics of a specific event or measuring how a specific event type trends over time. You can also engage with your users based on these events by creating campaigns in CleverTap that are triggered by them.

Event Categories

There are two categories of events in CleverTap: System Events and Custom Events.

System Events are events recorded automatically after you integrate our SDK. Custom Events are events you define and track with our SDK or API.

Event Properties

Events have details that describe the action taking place called properties.

For example, while recording the “Product viewed” event, you could also store event properties like product name, category, and price. Recording event properties will help you answer questions like which category of products are more popular, and help you segment users based on which categories or price points they’ve viewed.

System Events

System Events are events recorded automatically after you integrate our SDK.

Event Type
Description
How Event is Tracked

App Installed

This event is recorded when a user installs your application.

The event is raised when the user launches the app for the first time.

There are three cases when this event will be recorded multiple times for a single user. The first case is when a user installs your app, uninstalls it, and then reinstalls it. The second case is when clear your app's memory. The third case is when a user installs your app on multiple devices.

App Launched

This event is recorded every time a user launches your application.

There are two cases when this event will recorded. The first case is a fresh app launch, which is when an app is launched from a killed state. The second case is when a app is brought to the foreground after 20 minutes of inactivity in the background.

App Uninstalled

This event is recorded when a user uninstalls your application.

This event is tracked by sending silent push notifications, which are type of notification that is not rendered on a user’s device. We send silent push notifications to your entire install base once every 24 hours to track uninstalls. For more information, please see App Uninstall.

UTM Visited

This event is tracked when user clicks on a link from a marketing campaign that has a UTM parameter defined on it. This event is also tracked when a CleverTap-integrated attribution platform, such as Branch or Apsalar, sends this information to CleverTap.

The UTM Visited event is recorded for your marketing campaigns from external sources, such as Google Adwords or AdRoll.

Notification Sent

This event is tracked when a campaign message is sent to a user. This event is always recorded, even if the user does not open or click on the message. This event is recorded for email, mobile push, SMS, web push, and Facebook Audience campaigns.

The event is tracked when the notification is successfully sent from CleverTap to the communication channel you select for your campaign.

Notification Viewed

This event is tracked when a user views an email, in-app notification, or a web notification sent from CleverTap.

The CleverTap SDK recognizes when a notification sent via CleverTap is viewed by a user.

Notification Viewed is available for Email, Web Push, InApp, Web Popup and App Inbox.

Notification Clicked

This event is tracked only when a user clicks on a campaign sent via CleverTap. You can track or create a Notification Clicked event for every UTM Visited event that is tracked by CleverTap and not any other provider. There is no separate event storage required for the Notification Clicked event because it is derived from the UTM Visited event.

Recorded when a user clicks on a mobile push, in-app, email, web-popup or web push message sent via the CleverTap dashboard, or through the campaign API.

The Android Push notifications containing deep links to third-party apps are not tracked.

Identity Set

This DEBUG event is raised when a new user is identified on a customer’s app or an identified user pushes another identity.

This event monitors the status and data points that are important for the identification and engagement of users. This event is for monitoring and debugging only.

Identity Reset

This DEBUG event is raised when a profile is de-merged (after de-merge a new profile for every device is created and identities are dropped) either from dashboard (“reset identities” click on profile page) or through the Demerge Profile API.

It monitors the reset of identities and handles unnecessary merges. This event is used for monitoring and debugging only.

Identity Error

This DEBUG event is raised when an existing identity is associated incorrectly with another identity. The former identity is now declared as invalid for the latter's profile.

This event is for monitoring and debugging only.

Custom Events

Custom Events are events you define and track with our SDK or API. For more information, please visit our developer documentation.

Event Metadata Recorded Automatically

For every event that’s recorded, CleverTap records the following standard metadata:

  • Information about the user who performed the event.
  • Date and time when the event was recorded.
  • The number of screens viewed by the user before performing the action.
  • The referring site and the source of the user visit if it was from an external source.

Additionally, CleverTap keeps the user profiles updated with the latest:

  • Geographic information like their city, region, country, and latitude/longitude (if available).
  • Browser or device make, model, etc. used to access the website or app.

System Properties

CleverTap tracks the following system properties automatically from the mobile SDK. All the system properties are prefixed by ‘CT’, indicating that they are provided by CleverTap.

The following properties are tracked automatically on all events:

System Property
Description

CT App version

This is the current version of your application installed on the user device.

CT Latitude

The user location identified by the latitude.

CT Longitude

The user location identified by the longitude.

CT Source

The source of the event.
For example, the event may originate from a Mobile SDK or an API.

All possible values:

  • Mobile (Mobile SDK)
  • MobileWeb (Web SDK)
  • Web (Web SDK)
  • API
  • segment
  • appsflyer
  • apsalar
  • branch
  • tune
  • System (For events generated by CleverTap)

The following properties are available on the App Launched event:

System Property
Description

CT App version

This is the current version of your application installed on the user device.

CT Latitude

The user location identified by the latitude.

CT Longitude

The user location identified by the longitude.

CT OS Version

The Operating system of the device.
For example, 1.0.0

CT SDK Version

The CleverTap SDK version. For example, 30501

CT Network Carrier

The network carrier of the device.
For example, AT&T, Vodafone.

CT Network Type

The network type of the device
For example, 4g

CT Connected To WiFi

Indicates if the device is connected to the Wi-FI.

CT Bluetooth Version

The Bluetooth version of the device

CT Bluetooth Enabled

Indicates if Bluetooth is enabled on the device.

CT Source

The source of the event.
For example, the event may originate from a Mobile SDK or an API.

All possible values:

  • Mobile (Mobile SDK)
  • MobileWeb (Web SDK)
  • Web (Web SDK)
  • API
  • segment
  • appsflyer
  • apsalar
  • branch
  • tune
  • System (For events generated by CleverTap)

Latitude and Longitude

The system properties 'latitude' and 'longitude' are captured and sent from the SDK only if the user gives consent on your app.

Events


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.