ClickedObjectIDsAfterSearch

algoliasearch.insights.ClickedObjectIDsAfterSearch
case class ClickedObjectIDsAfterSearch(eventName: String, eventType: ClickEvent, index: String, objectIDs: Seq[String], positions: Seq[Int], queryID: String, userToken: String, authenticatedUserToken: Option[String], timestamp: Option[Long]) 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

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.

index

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

objectIDs

Object IDs of the records that are part of the event.

positions

Position of the clicked item the search results. 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

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