ClickedObjectIDs

algoliasearch.insights.ClickedObjectIDs
case class ClickedObjectIDs(eventName: String, eventType: ClickEvent, index: String, objectIDs: Seq[String], userToken: String, authenticatedUserToken: Option[String], timestamp: Option[Long]) extends EventsItemsTrait

Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the "Clicked object IDs after search" event.

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.

index

The name of an Algolia index.

objectIDs

The object IDs of the records that are part of the event.

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 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