Track events

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

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

Send events to Edge Network

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:

productSku
rating
ratingText
reviewerId

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();
Copied to your clipboard
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)
Copied to your clipboard
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)

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];
Copied to your clipboard
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];

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();
Copied to your clipboard
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();

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)
Copied to your clipboard
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)

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];
Copied to your clipboard
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);
Copied to your clipboard
Edge.sendEvent(experienceEvent, null);

iOS

Swift

Edge.sendEvent(experienceEvent: experienceEvent)
Copied to your clipboard
Edge.sendEvent(experienceEvent: experienceEvent)

Objective-C

[AEPMobileEdge sendExperienceEvent:event completion:nil];
Copied to your clipboard
[AEPMobileEdge sendExperienceEvent:event completion:nil];

Java

Edge.sendEvent(experienceEvent, null);
Copied to your clipboard
Edge.sendEvent(experienceEvent, null);

Swift

Edge.sendEvent(experienceEvent: experienceEvent)
Copied to your clipboard
Edge.sendEvent(experienceEvent: experienceEvent)

Objective-C

[AEPMobileEdge sendExperienceEvent:event completion:nil];
Copied to your clipboard
[AEPMobileEdge sendExperienceEvent:event completion:nil];

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.

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

Syntax

public static void trackAction(final String action, final Map<String, String> contextData)
Copied to your clipboard
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);
Copied to your clipboard
Map<String, String> additionalContextData = new HashMap<String, String>();
additionalContextData.put("customKey", "value");
MobileCore.trackAction("loginClicked", additionalContextData);

iOS

Swift

Syntax

static func track(action: String?, data: [String: Any]?)
Copied to your clipboard
static func track(action: String?, data: [String: Any]?)

Example

MobileCore.track(action: "actionName", data: ["key": "value"])
Copied to your clipboard
MobileCore.track(action: "actionName", data: ["key": "value"])

Objective-C

Syntax

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

Example

[AEPMobileCore trackAction:@"action name" data:@{@"key": @"value"}];
Copied to your clipboard
[AEPMobileCore trackAction:@"action name" data:@{@"key": @"value"}];

Java

Syntax

public static void trackAction(final String action, final Map<String, String> contextData)
Copied to your clipboard
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);
Copied to your clipboard
Map<String, String> additionalContextData = new HashMap<String, String>();
additionalContextData.put("customKey", "value");
MobileCore.trackAction("loginClicked", additionalContextData);

Swift

Syntax

static func track(action: String?, data: [String: Any]?)
Copied to your clipboard
static func track(action: String?, data: [String: Any]?)

Example

MobileCore.track(action: "actionName", data: ["key": "value"])
Copied to your clipboard
MobileCore.track(action: "actionName", data: ["key": "value"])

Objective-C

Syntax

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

Example

[AEPMobileCore trackAction:@"action name" data:@{@"key": @"value"}];
Copied to your clipboard
[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.

Android

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

Java

Syntax

public static void trackState(final String state, final Map<String, String> contextData)
Copied to your clipboard
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);
Copied to your clipboard
Map<String, String> additionalContextData = new HashMap<String, String>();         
additionalContextData.put("customKey", "value");         
MobileCore.trackState("homePage", additionalContextData);

iOS

Swift

Syntax

static func track(state: String?, data: [String: Any]?) 
Copied to your clipboard
static func track(state: String?, data: [String: Any]?)

Example

MobileCore.track(state: "state name", data: ["key": "value"])
Copied to your clipboard
MobileCore.track(state: "state name", data: ["key": "value"])

Objective-C

Syntax

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

Example

[AEPMobileCore trackState:@"state name" data:@{@"key": @"value"}];
Copied to your clipboard
[AEPMobileCore trackState:@"state name" data:@{@"key": @"value"}];

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

Java

Syntax

public static void trackState(final String state, final Map<String, String> contextData)
Copied to your clipboard
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);
Copied to your clipboard
Map<String, String> additionalContextData = new HashMap<String, String>();         
additionalContextData.put("customKey", "value");         
MobileCore.trackState("homePage", additionalContextData);

Swift

Syntax

static func track(state: String?, data: [String: Any]?) 
Copied to your clipboard
static func track(state: String?, data: [String: Any]?)

Example

MobileCore.track(state: "state name", data: ["key": "value"])
Copied to your clipboard
MobileCore.track(state: "state name", data: ["key": "value"])

Objective-C

Syntax

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

Example

[AEPMobileCore trackState:@"state name" data:@{@"key": @"value"}];
Copied to your clipboard
[AEPMobileCore trackState:@"state name" data:@{@"key": @"value"}];

For more information, see the Mobile Core API Reference.

Get help

Visit the SDK community forum to ask questions
Contact Adobe Experience Cloud customer care for immediate assistance

Debugging and lifecycle data

Validation and next steps

Was this helpful?

Yes

Track events

Send events to Edge Network.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Create an Experience Event.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Java

Swift

Objective-C

Java

Swift

Objective-C

Send the Experience Event to Edge Network

Java

Swift

Objective-C

Java

Swift

Objective-C

Track user actions (for Adobe Analytics)

Java

Swift

Objective-C

Java

Swift

Objective-C

Track app states and screens (for Adobe Analytics)

Java

Swift

Objective-C

Java

Swift

Objective-C

Get help

Send events to Edge Network

Create an Experience Event