algoliasearch.insights
Members list
Type members
Classlikes
AddToCartEvent enumeration
AddToCartEvent enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
AddToCartEvent.type
Attributes
- Supertypes
-
class CustomSerializer[AddToCartEvent]trait Serializer[AddToCartEvent]class Objecttrait Matchableclass Any
Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the "Added to cart object IDs after search" event.
Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the "Added to cart object IDs after search" 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 theuserToken
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. - currency
-
Three-letter currency code.
- 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.
- objectData
-
Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as
objectIDs
. - objectIDs
-
Object IDs of the records that are part of the event.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event.
Use this event to track when users add items to their shopping cart after a previous Algolia request. 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 theuserToken
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. - currency
-
Three-letter currency code.
- 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.
- objectData
-
Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as
objectIDs
. - objectIDs
-
Object IDs of the records that are part of the event.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
ClickEvent enumeration
ClickEvent enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ClickEvent.type
Attributes
- Supertypes
-
class CustomSerializer[ClickEvent]trait Serializer[ClickEvent]class Objecttrait Matchableclass Any
Use this event to track when users click facet filters in your user interface.
Use this event to track when users click facet filters in your user interface.
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 theuserToken
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.
- filters
-
Applied facet filters. Facet filters are
facet:value
pairs. Facet values must be URL-encoded, such as,discount:10%25
. - index
-
Index name (case-sensitive) to which the event's items belong.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
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.
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
-
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 theuserToken
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.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
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.
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 theuserToken
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 eachobjectID
. - 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object Conversion.type
ConversionEvent enumeration
ConversionEvent enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
ConversionEvent.type
Attributes
- Supertypes
-
class CustomSerializer[ConversionEvent]trait Serializer[ConversionEvent]class Objecttrait Matchableclass Any
ConvertedFilters
ConvertedFilters
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 theuserToken
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.
- filters
-
Applied facet filters. Facet filters are
facet:value
pairs. Facet values must be URL-encoded, such as,discount:10%25
. - index
-
Index name (case-sensitive) to which the event's items belong.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Use this event to track when users convert on 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 conversion events related to Algolia requests, use the "Converted object IDs after search" event.
Use this event to track when users convert on 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 conversion events related to Algolia requests, use the "Converted object IDs after search" 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 theuserToken
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.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event.
Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. 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 theuserToken
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.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Absolute value of the discount for this product, in units of currency
.
Absolute value of the discount for this product, in units of currency
.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class DoubleValueclass StringValue
Attributes
- Supertypes
- Self type
-
DiscountSerializer.type
Error.
Error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
EventsItems
EventsItems
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
trait EventsItemsTraitclass AddedToCartObjectIDsclass ClickedFiltersclass ClickedObjectIDsclass ConvertedFiltersclass ConvertedObjectIDsclass PurchasedObjectIDsclass ViewedFiltersclass ViewedObjectIDsShow all
Attributes
- Companion
- trait
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
EventsItems.type
Attributes
- Supertypes
- Self type
Attributes
- Supertypes
- Known subtypes
-
class AddedToCartObjectIDsclass ClickedFiltersclass ClickedObjectIDsclass ConvertedFiltersclass ConvertedObjectIDsclass PurchasedObjectIDsclass ViewedFiltersclass ViewedObjectIDsShow all
The response of the Insights API.
The response of the Insights API.
Value parameters
- message
-
Details about the response, such as error messages.
- status
-
The HTTP status code of the response.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
InsightsEvents
InsightsEvents
Value parameters
- events
-
Click and conversion events. All events must be valid, otherwise the API returns an error.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
JsonSupport.type
ObjectData
ObjectData
Value parameters
- quantity
-
Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of
quantity
multiplied with theprice
for each purchased item.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
ObjectDataAfterSearch
ObjectDataAfterSearch
Value parameters
- quantity
-
Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of
quantity
multiplied with theprice
for each purchased item. - queryID
-
Unique identifier for a search query, used to track purchase events with multiple records that originate from different searches.
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
Total price of a product, including any discounts, in units of currency
.
Total price of a product, including any discounts, in units of currency
.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class DoubleValueclass StringValue
Attributes
- Supertypes
- Self type
-
PriceSerializer.type
PurchaseEvent enumeration
PurchaseEvent enumeration
Attributes
- Companion
- trait
- Supertypes
-
trait Sumtrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
PurchaseEvent.type
Attributes
- Supertypes
-
class CustomSerializer[PurchaseEvent]trait Serializer[PurchaseEvent]class Objecttrait Matchableclass Any
Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the "Purchased object IDs after search" event.
Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the "Purchased object IDs after search" 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 theuserToken
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. - currency
-
Three-letter currency code.
- 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.
- objectData
-
Extra information about the records involved in a purchase or add-to-cart event. If specified, it must have the same length as
objectIDs
. - objectIDs
-
Object IDs of the records that are part of the event.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
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.
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
-
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 theuserToken
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. - currency
-
Three-letter currency code.
- 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.
- objectData
-
Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as
objectIDs
. - objectIDs
-
Object IDs of the records that are part of the event.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Total monetary value of this event in units of currency
.
Total monetary value of this event in units of currency
.
Attributes
- Companion
- object
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class DoubleValueclass StringValue
Attributes
- Supertypes
- Self type
-
ValueSerializer.type
Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
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 theuserToken
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.
- filters
-
Applied facet filters. Facet filters are
facet:value
pairs. Facet values must be URL-encoded, such as,discount:10%25
. - index
-
Index name (case-sensitive) to which the event's items belong.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all
Use this event to track when users viewed items in the search results.
Use this event to track when users viewed items in the search results.
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 theuserToken
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.
- 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
- Supertypes
-
trait Serializabletrait Producttrait Equalstrait EventsItemsTraittrait EventsItemsclass Objecttrait Matchableclass AnyShow all