Algolia Tags extension overview

The Algolia Tags extension empowers marketers to easily set up rules that send user interaction data to Algolia, helping you deliver more personalized AI Search and Discovery experiences.

This extension is powered by a key feature:

Prerequisites prerequisites

You must have a valid Algolia account in order to use this extension. Go to the Algolia sign up page to create an account if you do not have one already.

Gather required configuration details configuration-details

To connect Algolia with Adobe Experience Platform, you’ll need the following information:

Install and configure the Algolia Insights extension install-configure

To install the Algolia Insights extension, navigate to the Data Collection UI and select Tags from the left navigation. From here, select a property to add the extension to, or create a new property instead.

Once you have selected or created the desired property, select Extensions in the left navigation, then select the Catalog tab. Search for the Algolia Insights card, then select Install.

In the configuration view that appears, you must provide the following details:

Algolia Insights extension action types action-types

Algolia supports a set of predefined standard events, each with specific contexts and properties. The actions available in the Algolia extension align with these event types, making it easy to categorize and configure the events you send to Algolia based on their type.

Load Insights load-insights

Add the Load Insights action to your tag rule wherever it makes the most sense for loading Algolia Insights based on your rule’s context. This action loads the search-insights.js library onto the page.

Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Load Insights as the Action Type.

Clicked clicked

Add the Click action to your tag rule to send clicked events to Algolia. Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Clicked as the Action Type.

For more information on the event categories, see the Clicked object IDs after search
and Clicked object IDs guides.

Converted converted

Add the Converted action to your tag rule to send converted events to Algolia. Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Converted as the Action Type.

For more information on the event categories, see the Converted object IDs after search and Converted object IDs guides.

Added to Cart added-to-cart

Add the Added to Cart action to your tag rule to send added to cart events to Algolia. Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Added to cart as the Action Type.

For more information on the event categories, see the Added to cart object IDs after search and Added to cart object IDs guides.

Purchased purchased

Add the Purchased action to your tag rule to send purchased events to Algolia. Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Purchased as the Action Type.

For more information on the event categories, see the Purchased object IDs after search
and Purchased object IDs guides.

Viewed viewed

Add the Viewed action to your tag rule to send purchased events to Algolia. Create a new tag rule or open an existing one. Define the conditions according to your requirements, then select Algolia as the Extension and select Viewed as the Action Type.

For more information on the view event, see the Viewed object IDs guide.

Algolia Insights extension data elements data-elements

Algolia supports a set of predefined data elements, each with specific contexts and properties. The following sections describes the data elements available in the Algolia Insights extension.

DataSet dataset

The DataSet Data Element retrieves data associated with HTML elements, which is then used in Algolia actions.

This Data Element returns:

{
  timestamp,
  queryID,
  indexName,
  objectIDs,
  positions
}

An example of HTML that contains dataset:

<div data-indexname="acme_master_default_products" class="instant-search-comp__hits">
  <div class="hit-card"
    data-insights-object-id="${hit.objectID}"
    data-insights-position="${hit.__position}"
    data-insights-query-id="${hit.__queryID}">
    <h4 class="hit-name">...</h4>
  </div>
</div>

Query String query-string

The Query String Data Element extracts data from the URL query string to be used in Algolia actions.

This Data Element returns:

{
  timestamp,
  queryID,
  indexName,
  objectIDs
}

An example of HTML that contains query parameters.

<a href="product.html?objectID=${hit.objectID}&queryID=${hit.__queryID}&indexName=${indexName}&position=${hit.position}">Read More</a>

Storage storage

The Storage Data Element retrieves data from Session Storage for use in Algolia actions.

This Data Element retrieves event details from Session Storage. No configuration is required. The data is automatically added during the click event action and removed during the convert event action.

This Data Element returns what is stored in the Session Storage.

{
  timestamp,
  queryID,
  indexName,
  objectIDs
}

Clicked or Converted after Search clicked-converted-after-search

The Clicked after Search or Converted after Search events require a queryId, and position is also required for Clicked after Search. These properties are available when the insights flag is enabled in InstantSearch and/or Autocomplete query parameters. Refer to the following resources to learn how to configure Insights for your site:

Next steps next-steps

This guide covered how to send data to Algolia using the Algolia Insights tag extension. If you are planning on also sending server-side events to Algolia, you can now proceed to install and configure the Conversions API event forwarding extension.

For more information on tags in Experience Platform, refer to the tags overview.