ClickedObjectIDs

algoliasearch.insights.ClickedObjectIDs
case class ClickedObjectIDs(eventName: String, eventType: ClickEvent, index: String, objectIDs: Seq[String], userToken: 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

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.

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