Filter Items

Reports that the user filtered the product list by a specific field value.

Parameters

  • name: Human-readable name, not used to identify an event type
  • properties: A container for the event properties as specified in the following table:
PropertyDescriptionType
dyTypeMust be "filter-items-v1"String
filterTypeName of the filter (color, size, brand, fit, author, keyword, category...)
Must correspond to a product property in your product feed.
String
filterNumericValueSpecify a value for this property OR for filterStringValue, but not both. This affects how segmentation conditions are run. Number
filterStringValueSpecify a value for this property OR for filterNumericValue, but not both. This affects how segmentation conditions are run.String

Example: Implementation via script, with filterNumericValue property

DY.API("event", {
  name: "Filter Items",
  properties: {
    dyType: "filter-items-v1",
    filterType: "color", // Name of filter (Color, Size, Brand, Fit, Author, Keyword, Category...)
    filterNumericValue: 4
  }
});

Example: Implementation via script, with filterStringValue property

DY.API("event", {
  name: "Filter Items",
  properties: {
    dyType: "filter-items-v1",
    filterType: "color", // Name of filter (Color, Size, Brand, Fit, Author, Keyword, Category...)
    filterStringValue: "Blue"
  }
});

Example: Implementation via Experience API (server-side)

"events":[
{
  name: "Filter Items",
  properties: {
    dyType: "filter-items-v1",
    filterType: "Brand", // Name of filter (Color, Size, Brand, Fit, Author, Keyword, Category...)
    filterStringValue: "Comverse"
  }
}]

👍

Go to the API reference for the Events endpoint to learn more.