Track events

The SDK provides three event tracking APIs to log events for reporting, segmentation, and various other data collection use cases:

  1. Send events to Edge Network (requires Edge Network extension)
  2. Track user actions (requires Adobe Analytics extension)
  3. Track app states and screens (requires Adobe Analytics extension)

Send events to Edge Network

data-variant=info

data-slots=text
This step requires knowledge of Experience Data Model (XDM) in Adobe Experience Platform. For more information about XDM, please read the XDM documentation.

The Edge Network extension provides an API to send an ExperienceEvent to Edge Network. An Experience Event is an object that contains data conforming to the XDM ExperienceEvent schema definition in Adobe Experience Platform.

In the following reference examples, you'll create an ExperienceEvent and then send it using the sendEvent API.

Additionally, you'll need to add the Environment Details field group and create a custom field group for product reviews that contain the following fields:

Create an Experience Event

Android Java

Map<String, Object> reviewXdmData = new HashMap<>();
reviewXdmData.put("productSku", "demo123");
reviewXdmData.put("rating", 5);
reviewXdmData.put("reviewText", "I love this demo!");
reviewXdmData.put("reviewerId", "Anonymous user");

Map<String, Object> xdmData = new HashMap<>();
xdmData.put("eventType", "MyFirstXDMExperienceEvent");
xdmData.put(_yourTenantId, reviewXdmData);

ExperienceEvent experienceEvent = new ExperienceEvent.Builder()
                .setXdmSchema(xdmData)
                .build();

iOS Swift

var xdmData : [String: Any] = [:]
xdmData["eventType"] = "MyFirstXDMExperienceEvent"
xdmData[_yourTenantId] = ["productSku": "demo123",
                          "rating": 5,
                          "reviewText": "I love this demo!",
                          "reviewerId": "Anonymous user"]
let experienceEvent = ExperienceEvent(xdm: xdmData)

iOS Objective-C

NSDictionary<NSString*, NSObject*>* xdmData;
[xdmData setValue:@"MyFirstXDMExperienceEvent" forKey:@"eventType"];
[xdmData setValue:@{@"productSku": @"demo123",
                    @"rating": @5,
                    @"reviewText": @"I love this demo!",
                    @"reviewerId": @"Anonymous user"}
                      forKey:_yourTenantId];
AEPExperienceEvent *experienceEvent = [[AEPExperienceEvent alloc] initWithXdm:xdmData data:nil datasetIdentifier:nil];

Send the Experience Event to Edge Network

Use the Adobe Experience Platform Edge Mobile Extension to send the Experience Event created in the previous step.

Android Java

Edge.sendEvent(experienceEvent, null);

iOS Swift

Edge.sendEvent(experienceEvent: experienceEvent)

iOS Objective-C

[AEPMobileEdge sendExperienceEvent:event completion:nil];

Track user actions (for Adobe Analytics)

This section shows you how to start track user actions in your mobile app. To view and report on this data in those respective solutions, set up Adobe Analytics or another Experience Cloud solution extensions.

Actions are events that occur in your app. Use this API to track and measure an action, where each action has one or more corresponding metrics that increment each time the event occurs. For example, you might call this API for every new subscription, every time an article is viewed, or every time a level is completed.

data-variant=warning

data-slots=text
You must call this API when an event that you want to track occurs. In addition to the action name, you can send additional context data with each track action call.

Android Java

data-slots=heading, code

data-repeat=2

Syntax

public static void trackAction(final String action, final Map<String, String> contextData)

Example

Map<String, String> additionalContextData = new HashMap<String, String>();
additionalContextData.put("customKey", "value");
MobileCore.trackAction("loginClicked", additionalContextData);

iOS Swift

data-slots=heading, code

data-repeat=2

Syntax

static func track(action: String?, data: [String: Any]?)

Example

MobileCore.track(action: "actionName", data: ["key": "value"])

iOS Objective-C

data-slots=heading, code

data-repeat=2

Syntax

@objc(trackAction:data:)
static func track(action: String?, data: [String: Any]?)

Example

[AEPMobileCore trackAction:@"action name" data:@{@"key": @"value"}];

Track app states and screens (for Adobe Analytics)

States represent screens or views in your app. The trackState method is called every time a new state is displayed in your application. For example, this method would be called when a user navigates from the home page to the news feed. This method also sends an Adobe Analytics state-tracking hit with optional context data.

On Android, trackState is typically called each time a new activity is loaded.

Android Java

data-slots=heading, code

data-repeat=2

Syntax

public static void trackState(final String state, final Map<String, String> contextData)

Example

Map<String, String> additionalContextData = new HashMap<String, String>();
additionalContextData.put("customKey", "value");
MobileCore.trackState("homePage", additionalContextData);

iOS Swift

data-slots=heading, code

data-repeat=2

Syntax

static func track(state: String?, data: [String: Any]?)

Example

MobileCore.track(state: "state name", data: ["key": "value"])

iOS Objective-C

data-slots=heading, code

data-repeat=2

Syntax

@objc(trackState:data:)
static func track(state: String?, data: [String: Any]?)

Example

[AEPMobileCore trackState:@"state name" data:@{@"key": @"value"}];

For more information, see the Mobile Core API Reference.

Get help