HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityLog In

Shared Filter Definitions

This topic describes how to use shared filter definitions and what options are available.

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/NameParametersDescription
epiAverageSpentamount (decimal)Customers with Average Order Value over X
epiCustomerPurchased-Customers who placed orders
epiHasViewedCategorycategoryName (string)Customers who viewed category X
epiHasViewedPagepageurl (string)Customers who opened URL (Have viewed a page)
epiHasViewedProductproductName (string)Customers who viewed product X
epiLessAverageSpentamount (decimal)Customers with an average order value less than X
epiOrderedMoreItemsitemCount (int)Customers who placed an order with more than X items in the cart
epiProductPurchasedproductReferenceCode (string)Customers who purchased product X
epiTopTotalOrdersorders (int)Customers who have made X or more orders
epiTotalSpentamount (decimal)Customers who spend over X

What’s Next
Did this page help you?