Event Management

What is an event?

Any action performed by the user in the application that is of interest for analytics and improving the app/user experience is an event. Every time such an action occurs, the details of this action is recorded in Upshot.ai as an event.

Examples of an event

Any button tap
User making an in-app purchase
User on visiting any particular screen, like “settings”
User set game difficulty to 'easy'

Dispatch Frequency

Events are dispatched to the server within a time interval of 10secs to 120secs. You can choose the frequency at which events should be dispatched. By default, events are dispatched to the server once in every 60 secs

Sample Code:

[[BrandKinesis sharedInstance] setDispatchInterval:30 ];

BrandKinesis.sharedInstance(). dispatchInterval = 30

Dispatch Events

DispatchEventsWithTimedEvents method allows you to flush all events from your app to the Upshot.ai server immediately. You can use this method for any particular action in your application.

dispatchEventsWithTimedEvents:Yes: Sending all closed and non-closed events to server.
dispatchEventsWithTimedEvents:No: Sending all closed events to server.

Sample Code:

[[BrandKinesis sharedInstance] dispatchEventsWithTimedEvents:YES completionBlock:^(BOOL dispatched) {
}];

BrandKinesis.sharedInstance(). dispatchEvents(withTimedEvents: true) { (status) in
}

Types of Event

Predefined Events

Upshot.ai defines a set of predefined events in the SDK.

Session Events:

A session represents a single continuous period of user interaction with your app. Sessions serve as useful containers of measured activity, which includes screen views, events, and other transactions. Every successful initialization of the SDK creates a new session. You should not attempt to create this event yourself.

Screen View Events:

Also referred as Page Views, defines which page is being currently viewed by the user and from which page/screen did he reach there.

NOTE:

For creating the pageview event the eventname should be BKPageViewNative or BKPageViewWeb.
The dictionary should contain the key BKCurrentPage to make this event as a PageView event.
The screen name Launch is used by the SDK to identify that the first page viewed by the user in the application.
Page view chains/flow/hierarchy and closing the page view events are managed by the SDK. Every time a new page view is created, the previous page view event is closed and mapped to the new page.
For every successful creation of pageview event SDK returns eventId if it fails return nil.

Sample Code:

[[BrandKinesis sharedInstance] createEvent:BKPageViewNative params:@{BKCurrentPage: @"Screen Name" } isTimed: YES];

BrandKinesis.sharedInstance().createEvent (BKPageViewNative, params: [BKCurrentPage: "Screen Name"], isTimed: true)

Check PageView events in Dashboard under Live Events Section :

Attribution Event

Upshot.ai helps you to track mobile app installations via Adjust or other Attribution platforms like AppsFlyer. After your app is installed from an Adjust media source, you can retrieve the install data using the Adjust SDK in your app and let Upshot.ai know about the installation source, medium, campaign, and other info.

NOTE:

Note:

Adjust SDK must be separately integrated into your app.
Import Adjust module into your AppDelegate class.
Confirm AdjustDelegate to AppDelegate class.
Configure Adjust framework in application:didfinishlaunchingwithoptions

Sample Code:

NSString *yourAppToken = @"{ADJUST_APP_TOKEN}";
NSString *environment = ADJEnvironmentProduction;
ADJConfig *adjustConfig = [ADJConfig configWithAppToken:yourAppToken environment:environment];
[adjustConfig setDelegate:self];
[Adjust appDidLaunch:adjustConfig];

Attribution callback

You can register a delegate callback to be notified of tracker attribution changes. Due to the different sources considered for attribution, this information can not be provided synchronously. Follow these steps to implement the optional delegate protocol in your app delegate.

Sample Code:

- (void)adjustAttributionChanged:(ADJAttribution *)attribution {
}

Attribution Response:

Here is a quick summary of its properties. If any value is unavailable, it will default to nil

NSString trackerToken the tracker token of the current attribution.
NSString trackerName the tracker name(medium) of the current attribution.
NSString network the network(source) grouping level of the current attribution.
NSString campaign the campaign grouping level of the current attribution.
NSString adgroup the ad group grouping level of the current attribution.
NSString creative the creative grouping level of the current attribution.
NSString clickLabel the click label of the current attribution.
NSString adid the unique device identifier provided by attribution.

Send Attribution Event to Upshot.ai

- (void)adjustAttributionChanged:(ADJAttribution *)attribution {
NSDictionary *payload = @{
BKAttributionSource: @"Adjust",
BKUTM_Source:attribution.network,
BKUTM_Medium:attribution.trackerName,
BKUTM_Campaign:attribution.network
};
[[BrandKinesis sharedInstance] createAttributionEvent:payload];
}

Custom Events

Any event that could not be accommodated through predefined events, can be created through Custom Events. Custom Events in Upshot.ai are classified as timed and non-timed events.

Non-Timed Events

An event where the start time and the end time are the same is a non-timed event.

Example: Say a button tap. It does not matter how long the button was pressed for. This becomes a non-timed event, where you are only interested in the fact that the user tapped a button, time factor is not crucial.

Sample Code:

NSDictionary *payload = @{
@"ItemCost": [NSNumber numberWithInteger:10000],
@"ItemName":@"Mobile"
};
NSString *eventId = [[BrandKinesis sharedInstance] createEvent:@"Purchase" params: payload isTimed: NO];

let options = ["ItemCost" : 10000,
"ItemName" : "Mobile"] as [String : Any]
let *eventId = BrandKinesis.sharedInstance().createEvent("Purchase", params: options, isTimed:false)

Timed Events

An event where the end time is different from the start time is a timed event.

Example: A game level takes 30 seconds to finish. So a “game level played” event starts at X and ends at Y. There's a time component associated with the event here, hence it is considered as a timed event.

Note:

While Creating the custom events Special Characters won't be allowed except _ in key's and eventName. Incase of any special characters SDK will replace with empty string.
EventName and Key's should start with alphabets only.
The data must be in key-value pairs.
All the keys must be Strings.
Each value must be either a String or a Number. Anything other than that will be auto converted to String.
Maximum length of each value is 2048 bytes.
The key-value pairs and the Eventname defined for the custom events must be consistent across all platforms to maintain data integrity.

Sample Code:

let options = ["ItemCost" : 10000,
"ItemName" : "Mobile"] as [String : Any]
let *eventId = BrandKinesis.sharedInstance().createEvent("Purchase", params: options, isTimed:true)

Note:

Every event is associated with an eventID. All the information relating to an event should be strictly mapped to its own eventID.
Incase of a timed event, the event should be closed with the same EventId with which the event had started.
Any data needed is set while closing the event using the same EventId. Data set on the event will be overwritten each time it is updated.
Timed events has to be close, Incase event is not closed sdk will not send those events to server in that session.
All Timed events are automatically closed when a session is terminated.

Sample Code to close event

[[BrandKinesis sharedInstance] closeEventForID:eventId];

BrandKinesis.sharedInstance(). closeEvent(forID: eventId)

Sample Code for Set Data And Close:

NSDictionary *payload = @{
@"ItemCost": [NSNumber numberWithInteger:10000],
@"ItemName":@"Mobile"
};
[[BrandKinesis sharedInstance] setValueAndClose:payload forEvent: eventId];

let payload = ["ItemCost" : 10000,
"ItemName" : "Mobile"] as [String : Any]
BrandKinesis.sharedInstance().setValueAndClose(options, forEvent: eventId)