Adobe Content Analytics API reference

This section details the publicly available API's for Content Analytics.

registerExperience

Registers an experience and return an ID to track the experience.

Android

Java

Syntax

static String registerExperience(List<ContentItem> assets, List<ContentItem> texts)
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts, List<ContentItem> ctas)

Copied to your clipboard
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts)
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts, List<ContentItem> ctas)

Example

String expId = ContentAnalytics.registerExperience(
    List.of(
        new ContentItem("https://example.com/product.jpg")
    ),
    List.of(
        new ContentItem("iPhone 16 Pro", Map.of("role", "headline")),
        new ContentItem("$999",          Map.of("role", "price"))
    ),
    List.of(
        new ContentItem("Buy Now", Map.of("enabled", true))
    )
);

ContentAnalytics.trackExperienceView(expId, "product.detail")
Copied to your clipboard
String expId = ContentAnalytics.registerExperience(
    List.of(
        new ContentItem("https://example.com/product.jpg")
    ),
    List.of(
        new ContentItem("iPhone 16 Pro", Map.of("role", "headline")),
        new ContentItem("$999",          Map.of("role", "price"))
    ),
    List.of(
        new ContentItem("Buy Now", Map.of("enabled", true))
    )
);

ContentAnalytics.trackExperienceView(expId, "product.detail")

Kotlin

Syntax

fun registerExperience(
    assets: List<ContentItem>,
    texts: List<ContentItem>,
    ctas: List<ContentItem>? = null
): String

Copied to your clipboard
fun registerExperience(
    assets: List<ContentItem>,
    texts: List<ContentItem>,
    ctas: List<ContentItem>? = null
): String

Example

// Using InteractionType enum directly
val expId = ContentAnalytics.registerExperience(
    assets = listOf(
        ContentItem("https://example.com/product.jpg")
    ),
    texts = listOf(
        ContentItem("iPhone 16 Pro", mapOf("role" to "headline")),
        ContentItem("$999", mapOf("role" to "price"))
    ),
    ctas = listOf(
        ContentItem("Buy Now", mapOf("enabled" to true))
    )
);

ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")
Copied to your clipboard
// Using InteractionType enum directly
val expId = ContentAnalytics.registerExperience(
    assets = listOf(
        ContentItem("https://example.com/product.jpg")
    ),
    texts = listOf(
        ContentItem("iPhone 16 Pro", mapOf("role" to "headline")),
        ContentItem("$999", mapOf("role" to "price"))
    ),
    ctas = listOf(
        ContentItem("Buy Now", mapOf("enabled" to true))
    )
);

ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")

iOS

Swift

Syntax

@discardableResult
static func registerExperience(
    assets: [ContentItem],
    texts: [ContentItem],
    ctas: [ContentItem]? = nil
) -> String
Copied to your clipboard
@discardableResult
static func registerExperience(
    assets: [ContentItem],
    texts: [ContentItem],
    ctas: [ContentItem]? = nil
) -> String

Example

let expId = ContentAnalytics.registerExperience(
    assets: [ContentItem(value: "https://example.com/product.jpg", styles: [:])],
    texts: [
        ContentItem(value: "iPhone 16 Pro", styles: ["role": "headline"]),
        ContentItem(value: "$999", styles: ["role": "price"])
    ],
    ctas: [ContentItem(value: "Buy Now", styles: ["enabled": true])]
)
ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")
Copied to your clipboard
let expId = ContentAnalytics.registerExperience(
    assets: [ContentItem(value: "https://example.com/product.jpg", styles: [:])],
    texts: [
        ContentItem(value: "iPhone 16 Pro", styles: ["role": "headline"]),
        ContentItem(value: "$999", styles: ["role": "price"])
    ],
    ctas: [ContentItem(value: "Buy Now", styles: ["enabled": true])]
)
ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")

Objective-C

Syntax

+ (NSString *)registerExperienceWithAssets:(NSArray<AEPContentItem *> *)assets
                                     texts:(NSArray<AEPContentItem *> *)texts
                                      ctas:(nullable NSArray<AEPContentItem *> *)ctas;
Copied to your clipboard
+ (NSString *)registerExperienceWithAssets:(NSArray<AEPContentItem *> *)assets
                                     texts:(NSArray<AEPContentItem *> *)texts
                                      ctas:(nullable NSArray<AEPContentItem *> *)ctas;

Example

NSString *expId = [AEPContentAnalytics registerExperienceWithAssets:@[
    [[AEPContentItem alloc] initWithValue:@"https://example.com/product.jpg" styles:@{}]
]
texts:@[
    [[AEPContentItem alloc] initWithValue:@"iPhone 16 Pro" styles:@{@"role": @"headline"}],
    [[AEPContentItem alloc] initWithValue:@"$999"          styles:@{@"role": @"price"}]
]
ctas:@[
    [[AEPContentItem alloc] initWithValue:@"Buy Now" styles:@{@"enabled": @YES}]
]];

[AEPContentAnalytics trackExperienceViewWithExperienceId:expId
                                     experienceLocation:@"product.detail"];
Copied to your clipboard
NSString *expId = [AEPContentAnalytics registerExperienceWithAssets:@[
    [[AEPContentItem alloc] initWithValue:@"https://example.com/product.jpg" styles:@{}]
]
texts:@[
    [[AEPContentItem alloc] initWithValue:@"iPhone 16 Pro" styles:@{@"role": @"headline"}],
    [[AEPContentItem alloc] initWithValue:@"$999"          styles:@{@"role": @"price"}]
]
ctas:@[
    [[AEPContentItem alloc] initWithValue:@"Buy Now" styles:@{@"enabled": @YES}]
]];

[AEPContentAnalytics trackExperienceViewWithExperienceId:expId
                                     experienceLocation:@"product.detail"];

Java

Syntax

static String registerExperience(List<ContentItem> assets, List<ContentItem> texts)
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts, List<ContentItem> ctas)

Copied to your clipboard
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts)
static String registerExperience(List<ContentItem> assets, List<ContentItem> texts, List<ContentItem> ctas)

Example

String expId = ContentAnalytics.registerExperience(
    List.of(
        new ContentItem("https://example.com/product.jpg")
    ),
    List.of(
        new ContentItem("iPhone 16 Pro", Map.of("role", "headline")),
        new ContentItem("$999",          Map.of("role", "price"))
    ),
    List.of(
        new ContentItem("Buy Now", Map.of("enabled", true))
    )
);

ContentAnalytics.trackExperienceView(expId, "product.detail")
Copied to your clipboard
String expId = ContentAnalytics.registerExperience(
    List.of(
        new ContentItem("https://example.com/product.jpg")
    ),
    List.of(
        new ContentItem("iPhone 16 Pro", Map.of("role", "headline")),
        new ContentItem("$999",          Map.of("role", "price"))
    ),
    List.of(
        new ContentItem("Buy Now", Map.of("enabled", true))
    )
);

ContentAnalytics.trackExperienceView(expId, "product.detail")

Kotlin

Syntax

fun registerExperience(
    assets: List<ContentItem>,
    texts: List<ContentItem>,
    ctas: List<ContentItem>? = null
): String

Copied to your clipboard
fun registerExperience(
    assets: List<ContentItem>,
    texts: List<ContentItem>,
    ctas: List<ContentItem>? = null
): String

Example

// Using InteractionType enum directly
val expId = ContentAnalytics.registerExperience(
    assets = listOf(
        ContentItem("https://example.com/product.jpg")
    ),
    texts = listOf(
        ContentItem("iPhone 16 Pro", mapOf("role" to "headline")),
        ContentItem("$999", mapOf("role" to "price"))
    ),
    ctas = listOf(
        ContentItem("Buy Now", mapOf("enabled" to true))
    )
);

ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")
Copied to your clipboard
// Using InteractionType enum directly
val expId = ContentAnalytics.registerExperience(
    assets = listOf(
        ContentItem("https://example.com/product.jpg")
    ),
    texts = listOf(
        ContentItem("iPhone 16 Pro", mapOf("role" to "headline")),
        ContentItem("$999", mapOf("role" to "price"))
    ),
    ctas = listOf(
        ContentItem("Buy Now", mapOf("enabled" to true))
    )
);

ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")

Swift

Syntax

@discardableResult
static func registerExperience(
    assets: [ContentItem],
    texts: [ContentItem],
    ctas: [ContentItem]? = nil
) -> String
Copied to your clipboard
@discardableResult
static func registerExperience(
    assets: [ContentItem],
    texts: [ContentItem],
    ctas: [ContentItem]? = nil
) -> String

Example

let expId = ContentAnalytics.registerExperience(
    assets: [ContentItem(value: "https://example.com/product.jpg", styles: [:])],
    texts: [
        ContentItem(value: "iPhone 16 Pro", styles: ["role": "headline"]),
        ContentItem(value: "$999", styles: ["role": "price"])
    ],
    ctas: [ContentItem(value: "Buy Now", styles: ["enabled": true])]
)
ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")
Copied to your clipboard
let expId = ContentAnalytics.registerExperience(
    assets: [ContentItem(value: "https://example.com/product.jpg", styles: [:])],
    texts: [
        ContentItem(value: "iPhone 16 Pro", styles: ["role": "headline"]),
        ContentItem(value: "$999", styles: ["role": "price"])
    ],
    ctas: [ContentItem(value: "Buy Now", styles: ["enabled": true])]
)
ContentAnalytics.trackExperienceView(experienceId: expId, experienceLocation: "product.detail")

Objective-C

Syntax

+ (NSString *)registerExperienceWithAssets:(NSArray<AEPContentItem *> *)assets
                                     texts:(NSArray<AEPContentItem *> *)texts
                                      ctas:(nullable NSArray<AEPContentItem *> *)ctas;
Copied to your clipboard
+ (NSString *)registerExperienceWithAssets:(NSArray<AEPContentItem *> *)assets
                                     texts:(NSArray<AEPContentItem *> *)texts
                                      ctas:(nullable NSArray<AEPContentItem *> *)ctas;

Example

NSString *expId = [AEPContentAnalytics registerExperienceWithAssets:@[
    [[AEPContentItem alloc] initWithValue:@"https://example.com/product.jpg" styles:@{}]
]
texts:@[
    [[AEPContentItem alloc] initWithValue:@"iPhone 16 Pro" styles:@{@"role": @"headline"}],
    [[AEPContentItem alloc] initWithValue:@"$999"          styles:@{@"role": @"price"}]
]
ctas:@[
    [[AEPContentItem alloc] initWithValue:@"Buy Now" styles:@{@"enabled": @YES}]
]];

[AEPContentAnalytics trackExperienceViewWithExperienceId:expId
                                     experienceLocation:@"product.detail"];
Copied to your clipboard
NSString *expId = [AEPContentAnalytics registerExperienceWithAssets:@[
    [[AEPContentItem alloc] initWithValue:@"https://example.com/product.jpg" styles:@{}]
]
texts:@[
    [[AEPContentItem alloc] initWithValue:@"iPhone 16 Pro" styles:@{@"role": @"headline"}],
    [[AEPContentItem alloc] initWithValue:@"$999"          styles:@{@"role": @"price"}]
]
ctas:@[
    [[AEPContentItem alloc] initWithValue:@"Buy Now" styles:@{@"enabled": @YES}]
]];

[AEPContentAnalytics trackExperienceViewWithExperienceId:expId
                                     experienceLocation:@"product.detail"];

trackAsset

Tracks an asset with an explicit defined interaction type.

Android

Java

Syntax

static void trackAsset(String assetURL)
static void trackAsset(String assetURL, InteractionType interactionType)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackAsset(String assetURL)
static void trackAsset(String assetURL, InteractionType interactionType)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation, Map<String, Object> additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    "https://example.com/image.jpg",
    InteractionType.VIEW,
    "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    "https://example.com/image.jpg",
    InteractionType.VIEW,
    "home"
);

Kotlin

Syntax

fun trackAsset(
    assetURL: String,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAsset(
    assetURL: String,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);

iOS

Swift

Syntax

static func trackAsset(
    assetURL: String,
    interactionType: InteractionType = .view,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAsset(
    assetURL: String,
    interactionType: InteractionType = .view,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAsset:(NSString *)assetURL
   interactionType:(AEPInteractionType)interactionType
     assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;
Copied to your clipboard
+ (void)trackAsset:(NSString *)assetURL
   interactionType:(AEPInteractionType)interactionType
     assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAsset:@"https://example.com/image.jpg"
                interactionType:AEPInteractionTypeView
                  assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAsset:@"https://example.com/image.jpg"
                interactionType:AEPInteractionTypeView
                  assetLocation:@"home"];

Java

Syntax

static void trackAsset(String assetURL)
static void trackAsset(String assetURL, InteractionType interactionType)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackAsset(String assetURL)
static void trackAsset(String assetURL, InteractionType interactionType)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation)
static void trackAsset(String assetURL, InteractionType interactionType, String assetLocation, Map<String, Object> additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    "https://example.com/image.jpg",
    InteractionType.VIEW,
    "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    "https://example.com/image.jpg",
    InteractionType.VIEW,
    "home"
);

Kotlin

Syntax

fun trackAsset(
    assetURL: String,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAsset(
    assetURL: String,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);

Swift

Syntax

static func trackAsset(
    assetURL: String,
    interactionType: InteractionType = .view,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAsset(
    assetURL: String,
    interactionType: InteractionType = .view,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    interactionType: InteractionType.VIEW,
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAsset:(NSString *)assetURL
   interactionType:(AEPInteractionType)interactionType
     assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;
Copied to your clipboard
+ (void)trackAsset:(NSString *)assetURL
   interactionType:(AEPInteractionType)interactionType
     assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAsset:@"https://example.com/image.jpg"
                interactionType:AEPInteractionTypeView
                  assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAsset:@"https://example.com/image.jpg"
                interactionType:AEPInteractionTypeView
                  assetLocation:@"home"];

trackAssetClick

Convenience method for tracking asset clicks.

Android

Java

Syntax

static void trackAssetClick(String assetURL)
static void trackAssetClick(String assetURL, String assetLocation)
static void trackAssetClick(String assetURL, String assetLocation, Map<String, Object> additionalData)
Copied to your clipboard
static void trackAssetClick(String assetURL)
static void trackAssetClick(String assetURL, String assetLocation)
static void trackAssetClick(String assetURL, String assetLocation, Map<String, Object> additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);

Kotlin

Syntax

fun trackAssetClick(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAssetClick(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);

iOS

Swift

Syntax

static func trackAssetClick(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAssetClick(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAssetClick(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAssetClick(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetClick:(NSString *)assetURL
    assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;
Copied to your clipboard
+ (void)trackAssetClick:(NSString *)assetURL
    assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAssetClick:@"https://example.com/image.jpg"
                       assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetClick:@"https://example.com/image.jpg"
                       assetLocation:@"home"];

Java

Syntax

static void trackAssetClick(String assetURL)
static void trackAssetClick(String assetURL, String assetLocation)
static void trackAssetClick(String assetURL, String assetLocation, Map<String, Object> additionalData)
Copied to your clipboard
static void trackAssetClick(String assetURL)
static void trackAssetClick(String assetURL, String assetLocation)
static void trackAssetClick(String assetURL, String assetLocation, Map<String, Object> additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);

Kotlin

Syntax

fun trackAssetClick(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAssetClick(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetClick(
    "https://example.com/image.jpg",
    "home",
    null
);

Swift

Syntax

static func trackAssetClick(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAssetClick(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAssetClick(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAssetClick(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetClick:(NSString *)assetURL
    assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;
Copied to your clipboard
+ (void)trackAssetClick:(NSString *)assetURL
    assetLocation:(nullable NSString *)assetLocation
    additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAssetClick:@"https://example.com/image.jpg"
                       assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetClick:@"https://example.com/image.jpg"
                       assetLocation:@"home"];

trackAssetCollection

Tracks multiple assets with the same interaction type.

Android

Java

Syntax

static void trackAssetCollection(List<String> assetURLs)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType, String assetLocation)

Copied to your clipboard
static void trackAssetCollection(List<String> assetURLs)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType, String assetLocation)

Example

ContentAnalytics.trackAssetCollection(
    List.of(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    "product-carousel"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    List.of(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    "product-carousel"
);

Kotlin

Syntax

fun trackAssetCollection(
    assetURLs: List<String>,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null
): Unit
Copied to your clipboard
fun trackAssetCollection(
    assetURLs: List<String>,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null
): Unit

Example

ContentAnalytics.trackAssetCollection(
    assetURLs = listOf(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    assetLocation = "product-carousel"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    assetURLs = listOf(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    assetLocation = "product-carousel"
);

iOS

Swift

Syntax

static func trackAssetCollection(
    assetURLs: [String],
    interactionType: InteractionType = .view,
    assetLocation: String? = nil
)
Copied to your clipboard
static func trackAssetCollection(
    assetURLs: [String],
    interactionType: InteractionType = .view,
    assetLocation: String? = nil
)

Example

ContentAnalytics.trackAssetCollection(
    assetURLs: ["https://example.com/image1.jpg", "https://example.com/image1.jpg"],
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    assetURLs: ["https://example.com/image1.jpg", "https://example.com/image1.jpg"],
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetCollectionWithAssetURLs:(NSArray<NSString *> *)assetURLs
                          interactionType:(AEPInteractionType)interactionType
                            assetLocation:(nullable NSString *)assetLocation;
Copied to your clipboard
+ (void)trackAssetCollectionWithAssetURLs:(NSArray<NSString *> *)assetURLs
                          interactionType:(AEPInteractionType)interactionType
                            assetLocation:(nullable NSString *)assetLocation;

Example

[AEPContentAnalytics trackAssetCollectionWithAssetURLs:@[@"https://example.com/image1.jpg",@"https://example.com/image1.jpg"]
                                       interactionType:AEPInteractionTypeView
                                         assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetCollectionWithAssetURLs:@[@"https://example.com/image1.jpg",@"https://example.com/image1.jpg"]
                                       interactionType:AEPInteractionTypeView
                                         assetLocation:@"home"];

Java

Syntax

static void trackAssetCollection(List<String> assetURLs)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType, String assetLocation)

Copied to your clipboard
static void trackAssetCollection(List<String> assetURLs)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType)
static void trackAssetCollection(List<String> assetURLs, InteractionType interactionType, String assetLocation)

Example

ContentAnalytics.trackAssetCollection(
    List.of(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    "product-carousel"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    List.of(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    "product-carousel"
);

Kotlin

Syntax

fun trackAssetCollection(
    assetURLs: List<String>,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null
): Unit
Copied to your clipboard
fun trackAssetCollection(
    assetURLs: List<String>,
    interactionType: InteractionType = InteractionType.VIEW,
    assetLocation: String? = null
): Unit

Example

ContentAnalytics.trackAssetCollection(
    assetURLs = listOf(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    assetLocation = "product-carousel"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    assetURLs = listOf(
        "https://example.com/img1.jpg",
        "https://example.com/img2.jpg"
    ),
    assetLocation = "product-carousel"
);

Swift

Syntax

static func trackAssetCollection(
    assetURLs: [String],
    interactionType: InteractionType = .view,
    assetLocation: String? = nil
)
Copied to your clipboard
static func trackAssetCollection(
    assetURLs: [String],
    interactionType: InteractionType = .view,
    assetLocation: String? = nil
)

Example

ContentAnalytics.trackAssetCollection(
    assetURLs: ["https://example.com/image1.jpg", "https://example.com/image1.jpg"],
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAssetCollection(
    assetURLs: ["https://example.com/image1.jpg", "https://example.com/image1.jpg"],
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetCollectionWithAssetURLs:(NSArray<NSString *> *)assetURLs
                          interactionType:(AEPInteractionType)interactionType
                            assetLocation:(nullable NSString *)assetLocation;
Copied to your clipboard
+ (void)trackAssetCollectionWithAssetURLs:(NSArray<NSString *> *)assetURLs
                          interactionType:(AEPInteractionType)interactionType
                            assetLocation:(nullable NSString *)assetLocation;

Example

[AEPContentAnalytics trackAssetCollectionWithAssetURLs:@[@"https://example.com/image1.jpg",@"https://example.com/image1.jpg"]
                                       interactionType:AEPInteractionTypeView
                                         assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetCollectionWithAssetURLs:@[@"https://example.com/image1.jpg",@"https://example.com/image1.jpg"]
                                       interactionType:AEPInteractionTypeView
                                         assetLocation:@"home"];

trackAssetView

Convenience method for tracking asset views.

Android

Java

Syntax

static void trackAssetView(String assetURL)
static void trackAssetView(String assetURL, String assetLocation)
static void trackAssetView(String assetURL, String assetLocation, Map<String, Object> additionalData)additionalData)

Copied to your clipboard
static void trackAssetView(String assetURL)
static void trackAssetView(String assetURL, String assetLocation)
static void trackAssetView(String assetURL, String assetLocation, Map<String, Object> additionalData)additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    "https://example.com/image.jpg",
    "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    "https://example.com/image.jpg",
    "home"
);

Kotlin

Syntax

fun trackAssetView(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAssetView(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

iOS

Swift

Syntax

static func trackAssetView(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAssetView(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetView:(NSString *)assetURL
         assetLocation:(nullable NSString *)assetLocation
        additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackAssetView:(NSString *)assetURL
         assetLocation:(nullable NSString *)assetLocation
        additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAssetView:@"https://example.com/image.jpg"
                      assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetView:@"https://example.com/image.jpg"
                      assetLocation:@"home"];

Java

Syntax

static void trackAssetView(String assetURL)
static void trackAssetView(String assetURL, String assetLocation)
static void trackAssetView(String assetURL, String assetLocation, Map<String, Object> additionalData)additionalData)

Copied to your clipboard
static void trackAssetView(String assetURL)
static void trackAssetView(String assetURL, String assetLocation)
static void trackAssetView(String assetURL, String assetLocation, Map<String, Object> additionalData)additionalData)

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    "https://example.com/image.jpg",
    "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    "https://example.com/image.jpg",
    "home"
);

Kotlin

Syntax

fun trackAssetView(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackAssetView(
    assetURL: String,
    assetLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackAssetView(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

Swift

Syntax

static func trackAssetView(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackAssetView(
    assetURL: String,
    assetLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/image.jpg",
    assetLocation: "home"
);

Objective-C

Syntax

+ (void)trackAssetView:(NSString *)assetURL
         assetLocation:(nullable NSString *)assetLocation
        additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackAssetView:(NSString *)assetURL
         assetLocation:(nullable NSString *)assetLocation
        additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackAssetView:@"https://example.com/image.jpg"
                      assetLocation:@"home"];
Copied to your clipboard
[AEPContentAnalytics trackAssetView:@"https://example.com/image.jpg"
                      assetLocation:@"home"];

trackExperienceClick

Tracks when an experience is clicked.

You must call registerExperience() before you can track experience clicks. See the Experience Tracking Guide for detailed usage patterns.

Android

Java

Syntax

static void trackExperienceClick(String experienceId)
static void trackExperienceClick(String experienceId, String experienceLocation)
static void trackExperienceClick(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackExperienceClick(String experienceId)
static void trackExperienceClick(String experienceId, String experienceLocation)
static void trackExperienceClick(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Example

ContentAnalytics.trackExperienceClick(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);
Copied to your clipboard
ContentAnalytics.trackExperienceClick(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);

Kotlin

Syntax

fun trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

iOS

Swift

Syntax

static func trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Objective-C

Syntax

+ (void)trackExperienceClick:(NSString *)assetURL
               assetLocation:(nullable NSString *)assetLocation
              additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackExperienceClick:(NSString *)assetURL
               assetLocation:(nullable NSString *)assetLocation
              additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackExperienceClick:expId
                       experienceLocation:@"homepage.hero"
                           additionalData:@{@"viewDuration": @5.2}];
Copied to your clipboard
[AEPContentAnalytics trackExperienceClick:expId
                       experienceLocation:@"homepage.hero"
                           additionalData:@{@"viewDuration": @5.2}];

Java

Syntax

static void trackExperienceClick(String experienceId)
static void trackExperienceClick(String experienceId, String experienceLocation)
static void trackExperienceClick(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackExperienceClick(String experienceId)
static void trackExperienceClick(String experienceId, String experienceLocation)
static void trackExperienceClick(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Example

ContentAnalytics.trackExperienceClick(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);
Copied to your clipboard
ContentAnalytics.trackExperienceClick(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);

Kotlin

Syntax

fun trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Swift

Syntax

static func trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackExperienceClick(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
ContentAnalytics.trackExperienceClick(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Objective-C

Syntax

+ (void)trackExperienceClick:(NSString *)assetURL
               assetLocation:(nullable NSString *)assetLocation
              additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackExperienceClick:(NSString *)assetURL
               assetLocation:(nullable NSString *)assetLocation
              additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackExperienceClick:expId
                       experienceLocation:@"homepage.hero"
                           additionalData:@{@"viewDuration": @5.2}];
Copied to your clipboard
[AEPContentAnalytics trackExperienceClick:expId
                       experienceLocation:@"homepage.hero"
                           additionalData:@{@"viewDuration": @5.2}];

trackExperienceView

Tracks when an experience is viewed.

You must call registerExperience() before you can track experience views. See the Experience Tracking Guide for detailed usage patterns.

Android

Java

Syntax

static void trackExperienceView(String experienceId)
static void trackExperienceView(String experienceId, String experienceLocation)
static void trackExperienceView(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackExperienceView(String experienceId)
static void trackExperienceView(String experienceId, String experienceLocation)
static void trackExperienceView(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Example

ContentAnalytics.trackExperienceView(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);
Copied to your clipboard
ContentAnalytics.trackExperienceView(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);

Kotlin

Syntax

fun trackExperienceView(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackExperienceView(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

iOS

Swift

Syntax

static func trackExperienceView(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackExperienceView(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Objective-C

Syntax

+ (void)trackExperienceView:(NSString *)assetURL
              assetLocation:(nullable NSString *)assetLocation
             additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackExperienceView:(NSString *)assetURL
              assetLocation:(nullable NSString *)assetLocation
             additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackExperienceView:expId
                      experienceLocation:@"homepage.hero"
                          additionalData:@{@"viewDuration": @5.2}];
Copied to your clipboard
[AEPContentAnalytics trackExperienceView:expId
                      experienceLocation:@"homepage.hero"
                          additionalData:@{@"viewDuration": @5.2}];

Java

Syntax

static void trackExperienceView(String experienceId)
static void trackExperienceView(String experienceId, String experienceLocation)
static void trackExperienceView(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Copied to your clipboard
static void trackExperienceView(String experienceId)
static void trackExperienceView(String experienceId, String experienceLocation)
static void trackExperienceView(String experienceId, String experienceLocation, Map<String, Object> additionalData)

Example

ContentAnalytics.trackExperienceView(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);
Copied to your clipboard
ContentAnalytics.trackExperienceView(
    expId,
    "homepage.hero",
    Map.of("viewDuration", 5.2)
);

Kotlin

Syntax

fun trackExperienceView(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit
Copied to your clipboard
fun trackExperienceView(
    experienceId: String,
    experienceLocation: String? = null,
    additionalData: Map<String, Any>? = null
): Unit

Example

// Using InteractionType enum directly
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
// Using InteractionType enum directly
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Swift

Syntax

static func trackExperienceView(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)
Copied to your clipboard
static func trackExperienceView(
    experienceId: String,
    experienceLocation: String? = nil,
    additionalData: [String: Any]? = nil
)

Example

ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)
Copied to your clipboard
ContentAnalytics.trackExperienceView(
    experienceId: expId,
    experienceLocation: "homepage.hero",
    additionalData: ["viewDuration": 5.2]
)

Objective-C

Syntax

+ (void)trackExperienceView:(NSString *)assetURL
              assetLocation:(nullable NSString *)assetLocation
             additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Copied to your clipboard
+ (void)trackExperienceView:(NSString *)assetURL
              assetLocation:(nullable NSString *)assetLocation
             additionalData:(nullable NSDictionary<NSString *,id> *)additionalData;

Example

[AEPContentAnalytics trackExperienceView:expId
                      experienceLocation:@"homepage.hero"
                          additionalData:@{@"viewDuration": @5.2}];
Copied to your clipboard
[AEPContentAnalytics trackExperienceView:expId
                      experienceLocation:@"homepage.hero"
                          additionalData:@{@"viewDuration": @5.2}];

Data types

contentItem

Represents the content within an experience (assets, texts, CTAs).

Android

Java

Syntax

public class ContentItem {
    private final String value;
    private final Map<String, Object> styles;

    public ContentItem(String value, Map<String, Object> styles) {
        this.value = value;
        this.styles = styles;
    }

    // Convenience constructor to mirror the default parameter
    public ContentItem(String value) {
        this(value, Collections.emptyMap());
    }

    public String getValue() {
        return value;
    }

    public Map<String, Object> getStyles() {
        return styles;
    }

    public Map<String, Object> toMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("value", value);
        map.put("styles", styles);
        return map;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof ContentItem)) return false;
        ContentItem that = (ContentItem) o;
        return Objects.equals(value, that.value) &&
               Objects.equals(styles, that.styles);
    }

    @Override
    public int hashCode() {
        return Objects.hash(value, styles);
    }

    @Override
    public String toString() {
        return "ContentItem{value='" + value + "', styles=" + styles + "}";
    }
}
Copied to your clipboard
public class ContentItem {
    private final String value;
    private final Map<String, Object> styles;

    public ContentItem(String value, Map<String, Object> styles) {
        this.value = value;
        this.styles = styles;
    }

    // Convenience constructor to mirror the default parameter
    public ContentItem(String value) {
        this(value, Collections.emptyMap());
    }

    public String getValue() {
        return value;
    }

    public Map<String, Object> getStyles() {
        return styles;
    }

    public Map<String, Object> toMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("value", value);
        map.put("styles", styles);
        return map;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof ContentItem)) return false;
        ContentItem that = (ContentItem) o;
        return Objects.equals(value, that.value) &&
               Objects.equals(styles, that.styles);
    }

    @Override
    public int hashCode() {
        return Objects.hash(value, styles);
    }

    @Override
    public String toString() {
        return "ContentItem{value='" + value + "', styles=" + styles + "}";
    }
}

Example

// Asset with URL
ContentItem("https://example.com/hero.jpg")

// Text with role
ContentItem("Welcome!", mapOf("role" to "headline"))

// CTA with enabled state
ContentItem("Shop Now", mapOf("enabled" to true, "role" to "primary"))
Copied to your clipboard
// Asset with URL
ContentItem("https://example.com/hero.jpg")

// Text with role
ContentItem("Welcome!", mapOf("role" to "headline"))

// CTA with enabled state
ContentItem("Shop Now", mapOf("enabled" to true, "role" to "primary"))

Kotlin

Syntax

data class ContentItem(
    val value: String,
    val styles: Map<String, Any> = emptyMap()
) {
    fun toMap(): Map<String, Any>
}
Copied to your clipboard
data class ContentItem(
    val value: String,
    val styles: Map<String, Any> = emptyMap()
) {
    fun toMap(): Map<String, Any>
}

Example

// Asset with URL
ContentItem(value: "https://example.com/hero.jpg")

// Text with role
ContentItem(value: "Welcome!", styles: mapOf("role" to "headline"))

// CTA with enabled state
ContentItem(value: "Shop Now", styles: mapOf("enabled" to true, "role" to "primary"))
Copied to your clipboard
// Asset with URL
ContentItem(value: "https://example.com/hero.jpg")

// Text with role
ContentItem(value: "Welcome!", styles: mapOf("role" to "headline"))

// CTA with enabled state
ContentItem(value: "Shop Now", styles: mapOf("enabled" to true, "role" to "primary"))

iOS

Swift

Syntax

public struct ContentItem {
    let value: String
    let styles: [String: Any]
    
    init(value: String, styles: [String: Any])
}
Copied to your clipboard
public struct ContentItem {
    let value: String
    let styles: [String: Any]
    
    init(value: String, styles: [String: Any])
}

Example

// Asset
ContentItem(value: "https://example.com/image.jpg", styles: [:])

// Text with role
ContentItem(value: "Product Title", styles: ["role": "headline"])
ContentItem(value: "$99.99", styles: ["role": "price"])

// CTA
ContentItem(value: "Buy Now", styles: ["enabled": true])
Copied to your clipboard
// Asset
ContentItem(value: "https://example.com/image.jpg", styles: [:])

// Text with role
ContentItem(value: "Product Title", styles: ["role": "headline"])
ContentItem(value: "$99.99", styles: ["role": "price"])

// CTA
ContentItem(value: "Buy Now", styles: ["enabled": true])

Objective-C

Syntax

@implementation AEPContentItem

- (instancetype)initWithValue:(NSString *)value
                       styles:(NSDictionary<NSString *, id> *)styles {
    if (self = [super init]) {
        _value = value;
        _styles = styles;
    }
    return self;
}
Copied to your clipboard
@implementation AEPContentItem

- (instancetype)initWithValue:(NSString *)value
                       styles:(NSDictionary<NSString *, id> *)styles {
    if (self = [super init]) {
        _value = value;
        _styles = styles;
    }
    return self;
}

Example

AEPContentItem *asset = [[AEPContentItem alloc] initWithValue:@"https://example.com/image.jpg"
                                                       styles:@{}];
                                                       

AEPContentItem *title = [[AEPContentItem alloc] initWithValue:@"Product Title"
                                                       styles:@{@"role": @"headline"}];
AEPContentItem *price = [[AEPContentItem alloc] initWithValue:@"$99.99"
                                                       styles:@{@"role": @"price"}];


AEPContentItem *cta = [[AEPContentItem alloc] initWithValue:@"Buy Now"
                                                     styles:@{@"enabled": @YES}];
Copied to your clipboard
AEPContentItem *asset = [[AEPContentItem alloc] initWithValue:@"https://example.com/image.jpg"
                                                       styles:@{}];
                                                       

AEPContentItem *title = [[AEPContentItem alloc] initWithValue:@"Product Title"
                                                       styles:@{@"role": @"headline"}];
AEPContentItem *price = [[AEPContentItem alloc] initWithValue:@"$99.99"
                                                       styles:@{@"role": @"price"}];


AEPContentItem *cta = [[AEPContentItem alloc] initWithValue:@"Buy Now"
                                                     styles:@{@"enabled": @YES}];

Java

Syntax

public class ContentItem {
    private final String value;
    private final Map<String, Object> styles;

    public ContentItem(String value, Map<String, Object> styles) {
        this.value = value;
        this.styles = styles;
    }

    // Convenience constructor to mirror the default parameter
    public ContentItem(String value) {
        this(value, Collections.emptyMap());
    }

    public String getValue() {
        return value;
    }

    public Map<String, Object> getStyles() {
        return styles;
    }

    public Map<String, Object> toMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("value", value);
        map.put("styles", styles);
        return map;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof ContentItem)) return false;
        ContentItem that = (ContentItem) o;
        return Objects.equals(value, that.value) &&
               Objects.equals(styles, that.styles);
    }

    @Override
    public int hashCode() {
        return Objects.hash(value, styles);
    }

    @Override
    public String toString() {
        return "ContentItem{value='" + value + "', styles=" + styles + "}";
    }
}
Copied to your clipboard
public class ContentItem {
    private final String value;
    private final Map<String, Object> styles;

    public ContentItem(String value, Map<String, Object> styles) {
        this.value = value;
        this.styles = styles;
    }

    // Convenience constructor to mirror the default parameter
    public ContentItem(String value) {
        this(value, Collections.emptyMap());
    }

    public String getValue() {
        return value;
    }

    public Map<String, Object> getStyles() {
        return styles;
    }

    public Map<String, Object> toMap() {
        Map<String, Object> map = new HashMap<>();
        map.put("value", value);
        map.put("styles", styles);
        return map;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (!(o instanceof ContentItem)) return false;
        ContentItem that = (ContentItem) o;
        return Objects.equals(value, that.value) &&
               Objects.equals(styles, that.styles);
    }

    @Override
    public int hashCode() {
        return Objects.hash(value, styles);
    }

    @Override
    public String toString() {
        return "ContentItem{value='" + value + "', styles=" + styles + "}";
    }
}

Example

// Asset with URL
ContentItem("https://example.com/hero.jpg")

// Text with role
ContentItem("Welcome!", mapOf("role" to "headline"))

// CTA with enabled state
ContentItem("Shop Now", mapOf("enabled" to true, "role" to "primary"))
Copied to your clipboard
// Asset with URL
ContentItem("https://example.com/hero.jpg")

// Text with role
ContentItem("Welcome!", mapOf("role" to "headline"))

// CTA with enabled state
ContentItem("Shop Now", mapOf("enabled" to true, "role" to "primary"))

Kotlin

Syntax

data class ContentItem(
    val value: String,
    val styles: Map<String, Any> = emptyMap()
) {
    fun toMap(): Map<String, Any>
}
Copied to your clipboard
data class ContentItem(
    val value: String,
    val styles: Map<String, Any> = emptyMap()
) {
    fun toMap(): Map<String, Any>
}

Example

// Asset with URL
ContentItem(value: "https://example.com/hero.jpg")

// Text with role
ContentItem(value: "Welcome!", styles: mapOf("role" to "headline"))

// CTA with enabled state
ContentItem(value: "Shop Now", styles: mapOf("enabled" to true, "role" to "primary"))
Copied to your clipboard
// Asset with URL
ContentItem(value: "https://example.com/hero.jpg")

// Text with role
ContentItem(value: "Welcome!", styles: mapOf("role" to "headline"))

// CTA with enabled state
ContentItem(value: "Shop Now", styles: mapOf("enabled" to true, "role" to "primary"))

Swift

Syntax

public struct ContentItem {
    let value: String
    let styles: [String: Any]
    
    init(value: String, styles: [String: Any])
}
Copied to your clipboard
public struct ContentItem {
    let value: String
    let styles: [String: Any]
    
    init(value: String, styles: [String: Any])
}

Example

// Asset
ContentItem(value: "https://example.com/image.jpg", styles: [:])

// Text with role
ContentItem(value: "Product Title", styles: ["role": "headline"])
ContentItem(value: "$99.99", styles: ["role": "price"])

// CTA
ContentItem(value: "Buy Now", styles: ["enabled": true])
Copied to your clipboard
// Asset
ContentItem(value: "https://example.com/image.jpg", styles: [:])

// Text with role
ContentItem(value: "Product Title", styles: ["role": "headline"])
ContentItem(value: "$99.99", styles: ["role": "price"])

// CTA
ContentItem(value: "Buy Now", styles: ["enabled": true])

Objective-C

Syntax

@implementation AEPContentItem

- (instancetype)initWithValue:(NSString *)value
                       styles:(NSDictionary<NSString *, id> *)styles {
    if (self = [super init]) {
        _value = value;
        _styles = styles;
    }
    return self;
}
Copied to your clipboard
@implementation AEPContentItem

- (instancetype)initWithValue:(NSString *)value
                       styles:(NSDictionary<NSString *, id> *)styles {
    if (self = [super init]) {
        _value = value;
        _styles = styles;
    }
    return self;
}

Example

AEPContentItem *asset = [[AEPContentItem alloc] initWithValue:@"https://example.com/image.jpg"
                                                       styles:@{}];
                                                       

AEPContentItem *title = [[AEPContentItem alloc] initWithValue:@"Product Title"
                                                       styles:@{@"role": @"headline"}];
AEPContentItem *price = [[AEPContentItem alloc] initWithValue:@"$99.99"
                                                       styles:@{@"role": @"price"}];


AEPContentItem *cta = [[AEPContentItem alloc] initWithValue:@"Buy Now"
                                                     styles:@{@"enabled": @YES}];
Copied to your clipboard
AEPContentItem *asset = [[AEPContentItem alloc] initWithValue:@"https://example.com/image.jpg"
                                                       styles:@{}];
                                                       

AEPContentItem *title = [[AEPContentItem alloc] initWithValue:@"Product Title"
                                                       styles:@{@"role": @"headline"}];
AEPContentItem *price = [[AEPContentItem alloc] initWithValue:@"$99.99"
                                                       styles:@{@"role": @"price"}];


AEPContentItem *cta = [[AEPContentItem alloc] initWithValue:@"Buy Now"
                                                     styles:@{@"enabled": @YES}];

interactionType

Defines the type of interaction, either a view or a click.

Android

Java

Syntax

public enum InteractionType {
    VIEW,
    CLICK,
    DEFINITION;

    public String getStringValue() {
        return name().toLowerCase();
    }
}
Copied to your clipboard
public enum InteractionType {
    VIEW,
    CLICK,
    DEFINITION;

    public String getStringValue() {
        return name().toLowerCase();
    }
}

Example

ContentAnalytics.trackAsset(
    "https://example.com/hero.jpg",
    InteractionType.VIEW
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    "https://example.com/hero.jpg",
    InteractionType.VIEW
)

Kotlin

Syntax

enum class InteractionType {
    VIEW,
    CLICK,
    DEFINITION;
    
    val stringValue: String
        get() = name.lowercase()
}
Copied to your clipboard
enum class InteractionType {
    VIEW,
    CLICK,
    DEFINITION;
    
    val stringValue: String
        get() = name.lowercase()
}

Example

ContentAnalytics.trackAsset(
    assetURL = "https://example.com/hero.jpg",
    interactionType = InteractionType.VIEW
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL = "https://example.com/hero.jpg",
    interactionType = InteractionType.VIEW
)

iOS

Swift

Syntax

public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}
Copied to your clipboard
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/hero.jpg",
    interactionType: .view
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/hero.jpg",
    interactionType: .view
)

Objective-C

Syntax

@objc(AEPInteractionType)
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}
Copied to your clipboard
@objc(AEPInteractionType)
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}

Example

[ContentAnalytics trackAsset:@"https://example.com/hero.jpg"
             interactionType:AEPInteractionTypeView
               assetLocation:nil
              additionalData:nil];
Copied to your clipboard
[ContentAnalytics trackAsset:@"https://example.com/hero.jpg"
             interactionType:AEPInteractionTypeView
               assetLocation:nil
              additionalData:nil];

Java

Syntax

public enum InteractionType {
    VIEW,
    CLICK,
    DEFINITION;

    public String getStringValue() {
        return name().toLowerCase();
    }
}
Copied to your clipboard
public enum InteractionType {
    VIEW,
    CLICK,
    DEFINITION;

    public String getStringValue() {
        return name().toLowerCase();
    }
}

Example

ContentAnalytics.trackAsset(
    "https://example.com/hero.jpg",
    InteractionType.VIEW
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    "https://example.com/hero.jpg",
    InteractionType.VIEW
)

Kotlin

Syntax

enum class InteractionType {
    VIEW,
    CLICK,
    DEFINITION;
    
    val stringValue: String
        get() = name.lowercase()
}
Copied to your clipboard
enum class InteractionType {
    VIEW,
    CLICK,
    DEFINITION;
    
    val stringValue: String
        get() = name.lowercase()
}

Example

ContentAnalytics.trackAsset(
    assetURL = "https://example.com/hero.jpg",
    interactionType = InteractionType.VIEW
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL = "https://example.com/hero.jpg",
    interactionType = InteractionType.VIEW
)

Swift

Syntax

public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}
Copied to your clipboard
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}

Example

ContentAnalytics.trackAsset(
    assetURL: "https://example.com/hero.jpg",
    interactionType: .view
)
Copied to your clipboard
ContentAnalytics.trackAsset(
    assetURL: "https://example.com/hero.jpg",
    interactionType: .view
)

Objective-C

Syntax

@objc(AEPInteractionType)
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}
Copied to your clipboard
@objc(AEPInteractionType)
public enum InteractionType: Int {
    case view = 0
    case click = 1
    
    public var stringValue: String { ... }
    public static func from(string: String) -> InteractionType?
}

Example

[ContentAnalytics trackAsset:@"https://example.com/hero.jpg"
             interactionType:AEPInteractionTypeView
               assetLocation:nil
              additionalData:nil];
Copied to your clipboard
[ContentAnalytics trackAsset:@"https://example.com/hero.jpg"
             interactionType:AEPInteractionTypeView
               assetLocation:nil
              additionalData:nil];

Configuration

The following config settings are available. These settings can also be managed within the Adobe Content Analytics extension.

Setting	Type	Default	Description
`configId`	String	N/A	Custom datastream for Content Analytics events (overrides edge.configId)
`batchingEnabled`	Boolean	true	Enable batching
`maxBatchSize`	Integer	10	Maximum events per batch.
`flushInterval`	Integer	2000	Flush interval (in milliseconds).
`trackExperiences`	Boolean	true	Enable experience tracking.
`excludedAssetLocationsRegexp`	String	-	Asset location regex pattern.
`excludedAssetUrlsRegexp`	String	-	Asset URL regex pattern.
`excludedExperienceLocationsRegexp`	String	-	Experience location regex pattern.
`debugLogging`	Boolean	false	Verbose logging.

Overview

Experience tracking

Last updated 5/4/2026

Was this helpful?

Yes

Adobe Content Analytics API reference

registerExperience.css-83mclq{margin-left:var(--spectrum-global-dimension-size-100);}

Java.css-jmmyhj{margin-left:var(--spectrum-global-dimension-size-50);}

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackAsset

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackAssetClick

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackAssetCollection

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackAssetView

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackExperienceClick

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

trackExperienceView

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

Data types

contentItem

Java

Kotlin

Swift

Objective-C

Java

Kotlin

Swift

Objective-C

interactionType

Java

Kotlin

Swift

Objective-C

Java

registerExperience

Java