Loading...
Area: Optimizely Profile Store

Shared Filter Definitions

Recommended reading 

Visitor Intelligence provides out-of-the-box filter definitions for the most common scenarios and different products. Customers can create segments based on these shared filter definitions and developers can use them for inspiration when creating their own.

Using shared filter definitions

Shared filter definitions are returned together with customer-created ones when listing or getting filter definitions by ID using Profile Store API endpoints. The Shared property indicates shared filter definitions.

A new segment can be created using a shared filter definition in the same way as when using a custom one.

Some shared filter definitions depend on events tracked for a specific product like Commerce. The list of required customer products is stored in the Products property. Profile Store API returns all out-of-the-box filter definitions regardless of the products used by the customer.

Note: Shared filter definitions cannot be updated or deleted.

Shared filter definitions typically have prefix epi in their ids and names. It is recommended to avoid using prefix epi when creating custom filter definitions.

Available shared filter definitions

The following filter definitions are available from Profile Store 1.24.0 release.

Id/Name Parameters Description
epiAverageSpent
amount (decimal)
Customers with Average Order Value over X
epiCustomerPurchased
-
Customers who placed orders
epiHasViewedCategory
categoryName (string)
Customers who viewed category X
epiHasViewedPage
pageurl (string)
Customers who opened URL (Have viewed a page)
epiHasViewedProduct
productName (string)
Customers who viewed product X
epiLessAverageSpent
amount (decimal)
Customers with an average order value less than X
epiOrderedMoreItems
itemCount (int)
Customers who placed an order with more than X items in the cart
epiProductPurchased
productReferenceCode (string)
Customers who purchased product X
epiTopTotalOrders
orders (int)
Customers who have made X or more orders
epiTotalSpent
amount (decimal)
Customers who spend over X
Do you find this information helpful? Please log in to provide feedback.

Last updated: Mar 25, 2021

Recommended reading