Send and Track Events

Pre-Requisites

Send Event

You can setup events on user actions in your app and configure workflows on top of it that triggers when the corresponding event is passed through App. Variables added in the template or workflow should be passed as event properties You can send Events from your app to SuprSend platform by using ssApi.track() method

//method
suprsend.track(event_name); //for single event

suprsend.track(event_name, property_obj); //for event with properties

//Sample to track an event
suprsend.track("clicked");

//Sample to track an event with one or more properties
suprsend.track("clicked", {"page":"Dashboard","city":"Bangalore"});

Naming Guideline:Event Name or Property Name does not start with $ or ss_, as we have reserved these symbols for our internal events and property names.

System Events tracked by SuprSend

There are some system events tracked by SuprSend SDK by default. These are some basic events, as well as events that are necessary for tracking notifications related activity (like delivered, clicked, etc). You are not required to do anything here.

Event Name	Description
$app_installed	$app_installed will get tracked when user launch his app for the first time. FYI cases in which it will also get called 1. When user launches his app for first time. 2. When user uninstall the app and installs it again. 3. [Multiple device login ]When user launch app for first time on different devices. 4. When user clears the app cache and relaunches the app.
$app_launched	Gets tracked when user launches the app each time.
$user_login	Gets tracked when user logs in inside the app
$user_logout	Gets tracked when user logs in to the app
$notification_delivered	Will get tracked when the suprsend notification payload is received at SDK end.
$notification_clicked	Will get tracked when user either clicks the notification body or any action button in the notification.
$notification_dismissed	Will get tracked when user dismisses the notification by left swiping the notification or by clicking on “Clear All” button

Advanced Concepts

1. Super Properties

Super Properties are data that are always sent with events data. These super properties will be sent in each event after calling this method. Super Properties will be stored in local storage, and will persist across invocations of app.

Set Super Property

There are some super properties that SuprSend SDK will send by default. Developer can set custom super properties as well with ssApi.getUser().setSuperProperty() method

//method

//for setting single super property
ssApi.getUser().setSuperProperty(key: String, value: Any)
//for setting multiple super properties
ssApi.getUser().setSuperProperties(jsonObject: JSONObject)

//Example

//for setting single super property
ssApi.getUser().setSuperProperty("Location", "Banglore")
//for setting multiple super properties
ssApi.getUser().setSuperProperties(JSONObject().apply {
    put("Location","XYZ")
    put("Pincode", 1234567)
    put("Amount", 99.99")
})

Default Super Properties tracked by SuprSend SDK:

Super Property	Description	Sample Value
$app_version_string	Version of your app	0.0.1
$app_build_number	Build number of your app	2
$os	Operating system of the user	android
$manufacturer	Manufacturer of the user’s device	OnePlus
$brand	Brand of the user’s device	OnePlus
$model	Model of the user’s device	GM1901
$deviceId	Device id	89eead05a0150146
$ss_sdk_version	SuprSend SDK version	0.1.31
$network	Network on which the user is	wifi
$connected	Whether the user is connected to the network	true

Unset Super Property

There are unset custom super properties with ssApi.getUser().unSetSuperProperty() method. This method will stop calling that property with every event trigger.

//method
ssApi.getUser().unSetSuperProperty(key: String)

//Example
ssApi.getUser().unSetSuperProperty(listOf("Location","Pincode","Amount"))

2. Special Events

Special events are some best use case events defined by SuprSend. You could call these events with some of their pre-defined properties.

Purchase Made

You can call purchase made event if user is doing a transaction on your platform. You can pass property values like product id, product name, and amount in the event.

ssApi.purchaseMade(properties: JSONObject)
ssApi.purchaseMade(JSONObject().apply {
            put("product_id", "P1")
            put("product_name", "Car")
            put("amount", "$15000")
        })

3. Flush Events

SuprSend SDK automatically flushes events at an interval of 5 seconds, and on certain activities like app relaunch, etc. If you wish to flush a time sensitive event to SuprSend immediately, you can use the suprSendApi.flush() method. All the system tracked events are flushed immediately

suprSendApi.flush();

Developer Resources

Updates and Versioning

Authentication

Security

SDKs and APIs

Features

Testing

Monitoring and Logging

Pre-Requisites

Send Event

System Events tracked by SuprSend

Advanced Concepts

1. Super Properties

2. Special Events

3. Flush Events

​Pre-Requisites

​Send Event

​System Events tracked by SuprSend

​Advanced Concepts

​1. Super Properties

​2. Special Events

​3. Flush Events

Pre-Requisites

Send Event

System Events tracked by SuprSend

Advanced Concepts

1. Super Properties

2. Special Events

3. Flush Events