---
updatedAt: 2026-01-22T11:09:43.000Z
---

# 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:

[block:parameters]
{
  "data": {
    "h-0": "Property",
    "h-1": "Description",
    "h-2": "Type",
    "0-0": "**dyType**",
    "0-1": "Must be \"filter-items-v1\"",
    "0-2": "String",
    "1-0": "**filterType**",
    "1-1": "Name of the filter (color, size, brand, fit, author, keyword, category...)  \nMust correspond to a product property in your product feed. ",
    "1-2": "String",
    "2-0": "**filterNumericValue**",
    "2-1": "Specify a value for this property **OR** for **filterStringValue**, but not both. This affects how segmentation conditions are run. ",
    "2-2": "Number",
    "3-0": "**filterStringValue**",
    "3-1": "Specify a value for this property **OR** for **filterNumericValue**, but not both. This affects how segmentation conditions are run.",
    "3-2": "String"
  },
  "cols": 3,
  "rows": 4,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]

**Example: Implementation via script, with filterNumericValue property**

```javascript
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)**

```json
"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](https://dy.dev/dy-dev/reference/track-events) to learn more.

<br>