algoliasearch-scala/algoliasearch/algoliasearch.insights/ClickedObjectIDsAfterSearch

ClickedObjectIDsAfterSearch

algoliasearch.insights.ClickedObjectIDsAfterSearch

case class ClickedObjectIDsAfterSearch(eventName: String, eventType: ClickEvent, index: String, objectIDs: Seq[String], positions: Seq[Int], queryID: String, userToken: String, timestamp: Option[Long], authenticatedUserToken: Option[String]) extends EventsItemsTrait

Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event.

Value parameters

authenticatedUserToken: User token for authenticated users.
eventName: Can contain up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's object-action framework.
index: Name of the Algolia index.
objectIDs: List of object identifiers for items of an Algolia index.
positions: Position of the clicked objects in the search results. The first search result has a position of 1 (not 0). You must provide 1 position for each objectID.
queryID: Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add clickAnalytics: true as a search request parameter, the query ID is included in the API response.
timestamp: Time 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: Anonymous or pseudonymous user identifier. > Note: Never include personally identifiable information in user tokens.

Attributes

Graph
Supertypes: trait Serializable

trait Product

trait Equals

trait EventsItemsTrait

trait EventsItems

class Object

trait Matchable

class Any
Show all

Members list

Value members

Inherited methods

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

In this article

Generated with