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

Identifier for authenticated users. When the user signs in, you can get an identifier from your system and send it as authenticatedUserToken. This lets you keep using the userToken from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see User token.

eventName

Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's object-action framework.

filters

Applied facet filters. Facet filters are facet:value pairs. Facet values must be URL-encoded, such as, discount:10%25.

index

Index name (case-sensitive) to which the event's items belong.

timestamp

Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.

userToken

Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see User token.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait EventsItems
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product