Report Methods

New Context-based Report Methods

Availability

Android: 1.0.6-A or later

iOS: 2026.01.06 or later

React-Native: 1.0.6-RN or later

Web:- 1.0.6-RN or later

reportAddToCartData

Android

IOS

React-Native

Web

Method Signature

public void reportAddToCartData(Context contextData)

Description

Reports an Add To Cart event to the SDK.

Example

CartLine cartLine = new CartLine();
cartLine.setSku("SKU");
cartLine.setPid("PID");
cartLine.setQuantity(2);
cartLine.setCurrency("US");
cartLine.setValue("20");

Context context = new Context();
context.addSingleCartData(cartLine);

personalization.reportAddToCartData(context);

Method Signature

public func reportAddToCartData(contextData: ContextObj)

Description

Reports an Add To Cart event to the SDK.

Example

let cartLine = CartLine(sku: "sku6", pid: "pid4", quantity: 3, currency: "curr1", value: "21")
let contextObj = ContextObj()      
        do {
            try contextObj.addSingleCartData(cartLine)
            personalization.reportAddToCartData(contextData: contextObj)
        } catch {
            print(error.localizedDescription)
        }

Method Signature

reportAddToCartData();

Description

Reports an Add To Cart event to the SDK.

Example

const context = new Context();

context
    .addSingleCartData()
    .product({
      sku: "SKU-123",
      pid: "ddsds",
      productId: "123",
      quantity: 1,
      value: "1999",
      currency: "INR",
    });

personalization.reportAddToCartData();

Method Signature

reportAddToCartData();

Description

Reports an Add To Cart event to the SDK.

Example

const context = new Context();

context
    .addSingleCartData()
    .product({
      sku: "SKU-123",
      pid: "ddsds",
      productId: "123",
      quantity: 1,
      value: "1999",
      currency: "INR",
    });

personalization.reportAddToCartData();

reportCartData

Android

IOS

React-Native

Web

Method Signature

public void reportCartData(Context contextData)

Description

Reports an Entire Cart state to the SDK.

Example

CartLine cartLine = new CartLine();
cartLine.setSku("SKU");
cartLine.setPid("PID");
cartLine.setQuantity(2);
cartLine.setCurrency("US");
cartLine.setValue("20");

Context context = new Context();
context.addAllCartData(cartLine);

personalization.addAllCartData(context);

Method Signature

public func reportCartData(contextData: ContextObj)

Description

Reports an Entire Cart state to the SDK.

Example

let cartLinesSample = [
            CartLine(sku: "SKU123", pid: "PID123", quantity: 1, currency: "USD", value: "19.99"),
            CartLine(sku: "SKU456", pid: "PID456", quantity: 2, currency: "USD", value: "39.98")
        ]
let contextObj = ContextObj()
        do {
            try contextObj.addAllCartData(cartLinesSample)
            personalization.reportCartData(contextData: contextObj)
        } catch {
            print(error.localizedDescription)
        }

Method Signature

reportCartData();

Description

Reports an Entire Cart state to the SDK.

Example

const context = new Context();
context
    .addAllCartData()
    .cartLines([
      {
        sku: "SKU-123",
        pid: "ddsds",
        productId: "123",
        quantity: 1,
        value: "1999",
        currency: "INR",
      },
    ]);

personalization.reportCartData(context);

Method Signature

reportCartData();

Description

Reports an Entire Cart state to the SDK.

Example

const context = new Context();
context
    .addAllCartData()
    .cartLines([
      {
        sku: "SKU-123",
        pid: "ddsds",
        productId: "123",
        quantity: 1,
        value: "1999",
        currency: "INR",
      },
    ]);

personalization.reportCartData(context);

reportImpressionsData

Android

IOS

React-Native

Web

Method Signature

public void reportImpressionsData(String[] ids)

Description

Reports impression events.

Each impression ID represents a token associated with an action received from a previous SDK response.

Example

public void reportImpressionsData(String[] ids)

Method Signature

reportImpressionsData()

Description

Reports impression events.

Each impression ID represents a token associated with an action received from a previous SDK response.

Example

personalization.reportImpressionsData(
    [ "3.MS4xLjE1MTQ4MDg5MDAuMDAwMDAw" ]
)

reportPageDetails

Android

IOS

React-native

Web

Method Signature

public void reportPageDetails(Context contextData)

Description

Reports a Page Detail events to the SDK.

Example

Context context = new Context();
context.addPageDetails(
    "home-page",
    "https://example.com",
    new String[] { "category1", "category2" },
    new String[] { "breadcrumb1", "breadcrumb2" },
    "abc/xyz/pqr/testpath"
);

personalization.reportPageDetails(context);

Method Signature

 public func reportPageDetails(contextData: ContextObj)

Description

Reports a Page Detail events to the SDK.

Example

let contextObj = ContextObj()
try? contextObj.addPageDetails(pageType: "home", path: "offers/deals", url: nil, categories: ["electronics", "sale"], breadcrumbs: ["home", "deals"])

personalization.reportPageDetails(contextData: contextObj)

Method Signature

reportPageDetails()

Description

Reports a Page Detail events to the SDK.

Example:-

const context = new Context();
context
    .addPageDetails()
    .url(window.location.href)
    .path(window.location.pathname)
    .pageType("home")
    .breadcrumbs(["Home"])
    .categories(["Homepage"]);

personalization.reportPageDetails();

Method Signature

reportPageDetails()

Description

Reports a Page Detail events to the SDK.

Example:-

const context = new Context();
context
    .addPageDetails()
    .url(window.location.href)
    .path(window.location.pathname)
    .pageType("home")
    .breadcrumbs(["Home"])
    .categories(["Homepage"]);

personalization.reportPageDetails();

reportPageEvents

Android

IOS

React-Native

Web

Method Signature

public void reportPageEvents(Context contextData)

Description

Reports one or more page events to the SDK.

Example

Context context = new Context();
context.addPageEventsData(new String[] { "buttonClick" });

personalization.reportPageEvents(context);

Method Signature

public func reportPageEvents(contextData: ContextObj)

Description

Reports one or more custom page events to the SDK.

Example

let contextObj = ContextObj()
try? contextObj.addPageEventsData(["pageLoad", "buttonClick", "formSubmit"])
personalization.reportPageEvents(contextData: contextObj)

Method Signature

reportPageEvents()

Description

Reports one or more page events to the SDK.

Example

const context = new Context();
context
    .addPageDetails()
    .url(window.location.href)
    .path(window.location.pathname)
    .pageType("home")
    .breadcrumbs(["Home"])
    .categories(["Homepage"]);

personalization.reportPageDetails();

Method Signature

reportPageEvents()

Description

Reports one or more page events to the SDK.

Example

const context = new Context();
context
    .addPageDetails()
    .url(window.location.href)
    .path(window.location.pathname)
    .pageType("home")
    .breadcrumbs(["Home"])
    .categories(["Homepage"]);

personalization.reportPageDetails();

reportProductDetails

Android

IOS

React-Native

Web

Method Signature

public void reportProductDetails(Context contextData)

Description

Reports a Product Detail View event to the SDK.

Example

Product product = new Product();
product.setProductId("PID");
product.setSku("SKU");

Context context = new Context();
context.addProductDetails(new Product[] { product });

personalization.reportProductDetails(context);

Method Signature

 public func reportProductDetails(contextData: ContextObj)

Description

Reports a Product Detail View event to the SDK.

Example

 let productsSample = [
            Product(productId: "PROD001", sku: "SKU001")
        ]
 let contextObj = ContextObj()

 try? contextObj.addProductDetails(productsSample)
 personalization.reportProductDetails(contextData: contextObj)

Method Signature

reportProductDetails()

Description

Reports a Product Detail View event to the SDK.

Example

const context = new Context();
context.
     addProductDetails().
     productId("123").
     productSKU("SKU-123")

personalization.reportProductDetails();

Method Signature

reportProductDetails()

Description

Reports a Product Detail View event to the SDK.

Example

const context = new Context();
context.
     addProductDetails().
     productId("123").
     productSKU("SKU-123")

personalization.reportProductDetails();

reportProductThumbnailData

Android

IOS

React-Native

Web

Method Signature

public void reportProductThumbnailData(Context contextData)

Description

Reports a Product Thumbnail View event to the SDK.

Example

Context context = new Context();
context.addProductThumbnailsData(new String[] { "product21", "product43" });

personalization.reportProductThumbnailData(context);

Method Signature

public func reportProductThumbnailData(contextData: ContextObj)

Description

Reports a Product Thumbnail View event to the SDK.

Example

 let contextObj = ContextObj()
 try? contextObj.addProductThumbnailsData(["PROD001", "PROD002", "PROD003"])
 personalization.reportProductThumbnailData(contextData: contextObj)

Method Signature

reportProductThumbnailData()

Description

Reports a Product Thumbnail View event to the SDK.

Example

const context = new Context();
context
  .addProductThumbnailsData()
  .product([
    "prod_101",
    "prod_102",
    "prod_103"
  ]);

personalization.reportProductThumbnailData();

Method Signature

reportProductThumbnailData()

Description

Reports a Product Thumbnail View event to the SDK.

Example:-

const context = new Context();
context
  .addProductThumbnailsData()
  .product([
    "prod_101",
    "prod_102",
    "prod_103"
  ]);

personalization.reportProductThumbnailData();

reportPurchaseData

Android

IOS

React-Native

Web

Method Signature

public void reportPurchaseData(Context contextData)

Description

Reports a Purchase event to the SDK, including associated line items.

Example

PurchaseLine purchaseLine = new PurchaseLine();
purchaseLine.setSku("SKU1");
purchaseLine.setPid("PID1");
purchaseLine.setQuantity(2);
purchaseLine.setCurrency("US");
purchaseLine.setValue("23.00");

Context context = new Context();
context.addPurchaseData("1b2c3d", new PurchaseLine[] { purchaseLine });

personalization.reportPurchaseData(context);

Method Signature

 public func reportPurchaseData(contextData: ContextObj)

Description

Reports a Purchase event to the SDK, including associated line items.

Example

 let purchaseLinesSample: [PurchaseLine] = [
            PurchaseLine(sku: "sku0", pid: "PID123", quantity: 1, currency: "USD", value: "19.99"),
            PurchaseLine(sku: "sku1", pid: "PID456", quantity: 2, currency: "USD", value: "39.98")
        ]
 let contextObj = ContextObj()

try? contextObj.addPurchaseData(purchaseId: "purchase123", purchaseLineData: purchaseLinesSample)
personalization.reportPurchaseData(contextData: contextObj)

Method Signature

 reportPurchaseData()

Description

Reports a Purchase event to the SDK, including associated line items.

Example:-

Context context = new Context();
context
  .addPurchaseData()
  .purchaseId("ORDER_12345")
  .purchaseLines([
    {
      pid: "p1",
      sku: "sku1",
      productId: "101",
      quantity: 2,
      value: 500,
      currency: "INR"
    },
    {
      pid: "p2",
      sku: "sku2",
      productId: "102",
      quantity: 1,
      value: 1200,
      currency: "INR"
    }
  ]);
personalization.reportPurchaseData();

Method Signature

 reportPurchaseData()

Description

Reports a Purchase event to the SDK, including associated line items.

Example:-

Context context = new Context();
context
  .addPurchaseData()
  .purchaseId("ORDER_12345")
  .purchaseLines([
    {
      pid: "p1",
      sku: "sku1",
      productId: "101",
      quantity: 2,
      value: 500,
      currency: "INR"
    },
    {
      pid: "p2",
      sku: "sku2",
      productId: "102",
      quantity: 1,
      value: 1200,
      currency: "INR"
    }
  ]);
personalization.reportPurchaseData();

reportRecClicksData

Android

IOS

React-Native

Web

Method Signature

eportRecClicksData(String[] tokens)

Description

Reports recommendation click events.

A click is recorded for each provided token.

Example

personalization.reportRecClicksData(
    new String[] { "rt.1.xxx", "rt.1.yyy" }
);

Method Signature

public func reportRecClicksData(tokens: [String])

Description

Reports recommendation click events.

A click is recorded for each provided token.

Example

personalization.reportRecClicksData(tokens: ["rt.1.xxx", "rt.1.yyy"])

Method Signature

reportRecClicksData()

Description

Reports recommendation click events.

A click is recorded for each provided token.

Example:-

personalization.reportRecClicksData(
  "rt.1.xxx", "rt.1.yyy"
);

Method Signature

reportRecClicksData()

Description

Reports recommendation click events.

A click is recorded for each provided token.

Example:-

personalization.reportRecClicksData(
  "rt.1.xxx", "rt.1.yyy"
);

reportRecImpressionsData

Android

IOS

React-Native

Web

Method Signature

public void reportRecImpressionsData(String[] tokens)

Description

Reports recommendation impression events.

An impression is recorded for each provided token.

Example

personalization.reportRecImpressionsData(
    new String[] { "rt.1.xxx", "rt.1.yyy" }
);

Method Signature

 public func reportRecImpressionsData(tokens: [String])

Description

Reports recommendation impression events.

An impression is recorded for each provided token.

Example

Method Signature

reportRecImpressionsData()

Description

Reports recommendation impression events.

An impression is recorded for each provided token.

Example:-

personalization.reportRecImpressionsData(
  "rt.1.xxx", "rt.1.yyy"
);

Method Signature

reportRecImpressionsData()

Description

Reports recommendation impression events.

An impression is recorded for each provided token.

Example:-

personalization.reportRecImpressionsData(
  "rt.1.xxx", "rt.1.yyy"
);

Report Methods

New Context-based Report Methods

reportAddToCartData

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

reportCartData

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

Method Signature

Description

Example﻿

reportImpressionsData

Method Signature

Description

Example

Method Signature

Method Signature

Description

Example

Method Signature

reportPageDetails

Method Signature

Description

Example

Method Signature

Description

Example

Method Signature

Description

Example:-

Method Signature

Description

Example:-

reportPageEvents

Method Signature

Description

Example

Method Signature

Description

Example

Method Signature

Description

Example

Method Signature

Description

Example

reportProductDetails

Method Signature

Description

Example

Method Signature

Description

Example

Method Signature

Description

Example

Method Signature

Description

Example

reportProductThumbnailData

Method Signature

Description

Example

Example

Example

Example

Example

Example

Example

Example

Example