ClickedFilters
algoliasearch.insights.ClickedFilters
case class ClickedFilters(eventName: String, eventType: ClickEvent, index: String, filters: Seq[String], userToken: String, authenticatedUserToken: Option[String], timestamp: Option[Long]) extends EventsItemsTrait
Use this event to track when users click facet filters in your user interface.
Value parameters
- authenticatedUserToken
-
An identifier for authenticated users. > Note: Never include personally identifiable information in user tokens.
- eventName
-
The name of the event, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's object-action framework.
- filters
-
Facet filters. Each facet filter string must be URL-encoded, such as,
discount:10%25
. - index
-
The name of an Algolia index.
- timestamp
-
The timestamp of the event in milliseconds in Unix epoch time. By default, the Insights API uses the time it receives an event as its timestamp.
- userToken
-
An anonymous or pseudonymous user identifier. > Note: Never include personally identifiable information in user tokens.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass Any
Members list
In this article