PurchasedObjectIDsAfterSearch

algoliasearch.insights.PurchasedObjectIDsAfterSearch
case class PurchasedObjectIDsAfterSearch(eventName: String, eventType: ConversionEvent, eventSubtype: PurchaseEvent, index: String, queryID: String, objectIDs: Seq[String], objectData: Option[Seq[ObjectDataAfterSearch]], currency: Option[String], userToken: String, timestamp: Option[Long], authenticatedUserToken: Option[String]) extends EventsItemsTrait

Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.

Value parameters

authenticatedUserToken

User token for authenticated users.

currency

If you include pricing information in the objectData parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.

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.

objectData

Extra information about the records involved in the event—for example, to add price and quantities of purchased products. If provided, must be the same length as objectIDs.

objectIDs

List of object identifiers for items of an Algolia index.

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