[Analytics] Track Autocomplete Events

Author: PierreGauthier

src/module-elasticsuite-analytics/Model/Search/Usage/Kpi/Report.php

@@ -56,6 +56,8 @@ public function getLabel(string $origin): string
                 return __('Search');
             case 'product_views_catalog_product_view_count':
                 return __('Recommender');
+            case 'product_views_catalogsearch_autocomplete_click_count':
+                return __('Autocomplete');
             default:
                 return __('Other');
         }
@@ -64,6 +66,7 @@ public function getLabel(string $origin): string
     /**
      * {@inheritdoc}
      * @SuppressWarnings(PHPMD.ElseExpression)
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     protected function processResponse(\Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse $response)
     {
@@ -84,10 +87,17 @@ protected function processResponse(\Smile\ElasticsuiteCore\Search\Adapter\Elasti
                 $data[$key] = (int) $value->getMetrics()['count'];
                 if ($value->getAggregations()->getBucket('origin')->getValues()) {
                     $originDetails = '';
+                    $rawData = [];
                     foreach ($value->getAggregations()->getBucket('origin')->getValues() ?? [] as $originData) {
                         $key = sprintf("%s_%s_count", $value->getValue(), $originData->getValue());
                         $data[$key] = (int) $originData->getMetrics()['count'];
-                        $originDetails .= "• {$this->getLabel($key)}: {$originData->getMetrics()['count']}\n";
+                        $label = $this->getLabel($key);
+                        if (!array_key_exists($label, $rawData)) {
+                            $rawData[$label] = $data[$key];
+                        }
+                    }
+                    foreach ($rawData as $label => $count) {
+                        $originDetails .= "• {$label}: {$count}\n";
                     }
                     $data[$value->getValue() . '_origin_details'] = $originDetails;
                 }

src/module-elasticsuite-analytics/Model/Search/Usage/Terms/AggregationProvider.php

@@ -85,7 +85,10 @@ public function getAggregation()
             'name'      => 'search_terms',
             'metrics'   => $this->getMetrics(),
             'pipelines' => $this->getPipelines(),
-            'childBuckets'  => [$this->getFilteredResultCountMetric()],
+            'childBuckets'  => [
+                $this->getFilteredResultCountMetric(),
+                $this->getPageTypeIdentifierBucket(),
+            ],
             'sortOrder' => ['unique_sessions' => 'desc'],
             'size'      => $this->helper->getMaxSearchTerms(),
         ];
@@ -153,6 +156,36 @@ protected function getFilteredResultCountMetric()
         );
     }
 
+    /**
+     * Return aggregation providing the page type identifier.
+     *
+     * @return BucketInterface
+     */
+    protected function getPageTypeIdentifierBucket()
+    {
+        return $this->aggregationFactory->create(
+            BucketInterface::TYPE_TERM,
+            [
+                'name'          => 'page_type_identifier',
+                'field'         => 'page.type.identifier',
+                'metrics'       => [
+                    $this->metricFactory->create(
+                        [
+                            'name' => 'unique_sessions',
+                            'field' => 'session.uid',
+                            'type' => MetricInterface::TYPE_CARDINALITY,
+                        ]
+                    ),
+                ],
+                'include'       => [
+                    'catalogsearch_result_index',
+                    'catalogsearch_autocomplete',
+                    'catalogsearch_autocomplete_click',
+                ],
+            ]
+        );
+    }
+
     /**
      * Return "only first page" query.
      *

src/module-elasticsuite-analytics/Model/Search/Usage/Terms/Report.php

@@ -13,16 +13,21 @@
  */
 namespace Smile\ElasticsuiteAnalytics\Model\Search\Usage\Terms;
 
+use Magento\Framework\Api\Search\AggregationValueInterface;
+use Magento\Framework\Api\Search\BucketInterface;
+use Magento\Framework\View\Element\Block\ArgumentInterface;
+use Magento\Search\Model\SearchEngine;
 use Smile\ElasticsuiteAnalytics\Model\AbstractReport;
 use Smile\ElasticsuiteAnalytics\Model\Report\SearchRequestBuilder;
+use Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse;
 
 /**
  * Search terms Report
  *
  * @category Smile
  * @package  Smile\ElasticsuiteAnalytics
  */
-class Report extends AbstractReport implements \Magento\Framework\View\Element\Block\ArgumentInterface
+class Report extends AbstractReport implements ArgumentInterface
 {
     /**
      * @var array
@@ -32,12 +37,12 @@ class Report extends AbstractReport implements \Magento\Framework\View\Element\B
     /**
      * Constructor.
      *
-     * @param \Magento\Search\Model\SearchEngine $searchEngine         Search engine.
-     * @param SearchRequestBuilder               $searchRequestBuilder Search request builder.
-     * @param array                              $postProcessors       Response post processors.
+     * @param SearchEngine         $searchEngine         Search engine.
+     * @param SearchRequestBuilder $searchRequestBuilder Search request builder.
+     * @param array                $postProcessors       Response post processors.
      */
     public function __construct(
-        \Magento\Search\Model\SearchEngine $searchEngine,
+        SearchEngine $searchEngine,
         SearchRequestBuilder $searchRequestBuilder,
         array $postProcessors = []
     ) {
@@ -49,7 +54,7 @@ public function __construct(
      * {@inheritdoc}
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
-    protected function processResponse(\Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse $response)
+    protected function processResponse(QueryResponse $response)
     {
         $data = [];
 
@@ -73,6 +78,13 @@ protected function processResponse(\Smile\ElasticsuiteCore\Search\Adapter\Elasti
                     }
                     $data[$searchTerm]['result_count'] = round((float) $resultCountMetrics ?: 0);
                 }
+                if ($value->getAggregations()->getBucket('page_type_identifier')) {
+                    $this->processAutocompleteData(
+                        $value->getAggregations()->getBucket('page_type_identifier'),
+                        $searchTerm,
+                        $data
+                    );
+                }
             }
         }
 
@@ -83,14 +95,38 @@ protected function processResponse(\Smile\ElasticsuiteCore\Search\Adapter\Elasti
         return $data;
     }
 
+    /**
+     * Process autocomplete data from page type aggregation.
+     *
+     * @param BucketInterface $pageTypeIdAgg Page type aggregation bucket.
+     * @param string          $searchTerm    Search term.
+     * @param array           $data          Aggregated data.
+     * @return void
+     */
+    private function processAutocompleteData(BucketInterface $pageTypeIdAgg, string $searchTerm, array &$data): void
+    {
+        $sessionsByPageType = [];
+        foreach ($pageTypeIdAgg->getValues() as $pageTypeIdVal) {
+            $sessionsByPageType[$pageTypeIdVal->getValue()] = $pageTypeIdVal->getMetrics()['unique_sessions'];
+        }
+
+        $typedWithClick = $sessionsByPageType['catalogsearch_autocomplete_click'] ?? 0;
+        $typedAndPressEnter = $sessionsByPageType['catalogsearch_result_index'] ?? 0;
+        $typedWithNoClick = $data[$searchTerm]['sessions'] - $typedWithClick - $typedAndPressEnter;
+
+        $data[$searchTerm]['sessions_without_click'] = $typedWithNoClick;
+        $data[$searchTerm]['sessions_with_click'] = $typedWithClick;
+        $data[$searchTerm]['sessions_with_submit']  = $typedAndPressEnter;
+    }
+
     /**
      * Return the bucket values from the main aggregation
      *
-     * @param \Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse $response ES Query response.
+     * @param QueryResponse $response ES Query response.
      *
-     * @return \Magento\Framework\Api\Search\AggregationValueInterface[]
+     * @return AggregationValueInterface[]
      */
-    private function getValues(\Smile\ElasticsuiteCore\Search\Adapter\Elasticsuite\Response\QueryResponse $response)
+    private function getValues(QueryResponse $response)
     {
         $bucket = $response->getAggregations()->getBucket('search_terms');
 

src/module-elasticsuite-analytics/i18n/de_DE.csv

@@ -28,7 +28,10 @@
 "Exact searches","Exakte Suche"
 "Conversion rate","Konversionsrate"
 "All sessions","Alle Sitzungen"
+"with clicks","Mit Klick"
 "With search","Mit Suche"
+"with submit","Mit Bestätigung"
+"without clicks","Ohne Klick"
 "Without search","Ohne Suche"
 "What is this ?","Was ist das?"
 "The terms listed below are the most popular search terms, whether they lead to exact or close matches.<br />The link on a term leads to its edit screen where you can either <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> the search results page or configure a redirection - for instance to redirect the user to a dedicated category.<br />The ""conversion rate"" column value is computed as the ratio of the number of sessions where an order was placed and the term(s) searched for on the total number of sessions where the term(s) were searched for.","Die unten aufgeführten Begriffe sind die beliebtesten Suchbegriffe, unabhängig davon, ob sie zu exakten oder geschlossenen Übereinstimmungen führen.<br />Der Link auf einem Begriff führt zu seinem Bearbeiten-Bildschirm, auf dem Sie entweder <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">Merchandise</a> der Suchergebnisseite vermarkten oder eine Umleitung konfigurieren können - zum Beispiel um den Benutzer in eine eigene Kategorie umzuleiten.<br />Der Spaltenwert der Spalte ""Konversionsrate"" wird als Verhältnis der Anzahl der Sitzungen berechnet, in denen eine Bestellung aufgegeben wurde, und der Suchtermin nach der Gesamtzahl der Sitzungen, nach denen die Begriffe gesucht wurden."

src/module-elasticsuite-analytics/i18n/en_US.csv

@@ -28,7 +28,10 @@
 "Exact searches","Exact searches"
 "Conversion rate","Conversion rate"
 "All sessions","All sessions"
+"with clicks","with clicks"
 "With search","With search"
+"with submit","with submit"
+"without clicks","without clicks"
 "Without search","Without search"
 "What is this ?","What is this ?"
 "The terms listed below are the most popular search terms, whether they lead to exact or close matches.<br />The link on a term leads to its edit screen where you can either <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> the search results page or configure a redirection - for instance to redirect the user to a dedicated category.<br />The ""conversion rate"" column value is computed as the ratio of the number of sessions where an order was placed and the term(s) searched for on the total number of sessions where the term(s) were searched for.","The terms listed below are the most popular search terms, whether they lead to exact or close matches.<br />The link on a term leads to its edit screen where you can either <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> the search results page or configure a redirection - for instance to redirect the user to a dedicated category.<br />The ""conversion rate"" column value is computed as the ratio of the number of sessions where an order was placed and the term(s) searched for on the total number of sessions where the term(s) were searched for."

src/module-elasticsuite-analytics/i18n/fr_FR.csv

@@ -28,7 +28,10 @@
 "Exact searches","Recherches exactes"
 "Conversion rate","Taux de conversion"
 "All sessions","Toute session"
+"with clicks","avec clic"
 "With search","Avec recherche"
+"with submit","avec validation"
+"without clicks","sans clic"
 "Without search","Sans recherche"
 "What is this ?","Qu'est-ce que c'est ?"
 "The terms listed below are the most popular search terms, whether they lead to exact or close matches.<br />The link on a term leads to its edit screen where you can either <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> the search results page or configure a redirection - for instance to redirect the user to a dedicated category.<br />The ""conversion rate"" column value is computed as the ratio of the number of sessions where an order was placed and the term(s) searched for on the total number of sessions where the term(s) were searched for.","Les termes listés ci-dessous sont les termes les plus populaires, qu'ils amènent à des résultats exacts ou approchants.<br />Le lien sous un terme permet d'atteindre son écran d'édition où vous pouvez soit <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandiser</a> la page de résultats soit bien configurer une redirection - par exemple en redirigeant l'utilisateur vers une catégorie dédiée.<br />La valeur de la colonne ""taux de conversion"" est calculée comme le rapport du nombre de sessions avec un passage de commande et la recherche du/de ce(s) terme(s) sur le nombre total de sessions avec ce(s) terme(s) de recherche."

src/module-elasticsuite-analytics/i18n/nl_NL.csv

@@ -28,7 +28,10 @@
 "Exact searches","Exacte zoekopdrachten"
 "Conversion rate","Conversion Rate"
 "All sessions","Alle sessies"
+"with clicks","Met klik"
 "With search","Met zoekopdracht"
+"with submit","Met bevestiging"
+"without clicks","Zonder klik"
 "Without search","Zonder zoekopdracht"
 "What is this ?","Wat is dit?"
 "The terms listed below are the most popular search terms, whether they lead to exact or close matches.<br />The link on a term leads to its edit screen where you can either <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> the search results page or configure a redirection - for instance to redirect the user to a dedicated category.<br />The ""conversion rate"" column value is computed as the ratio of the number of sessions where an order was placed and the term(s) searched for on the total number of sessions where the term(s) were searched for.","De onderstaande termen zijn de populairste zoektermen, ongeacht of ze leiden tot exacte of gesloten matches.<br />De link op een term leidt naar het bewerkingsscherm waar je ofwel <a href=""https://github.com/Smile-SA/elasticsuite/wiki/ProductSorting#using-the-merchandiser"" target=""_blank"">merchandise</a> de zoekresultaten pagina kunt weergeven of een omleiding kunt configureren - bijvoorbeeld om de gebruiker door te verwijzen naar een speciale categorie.<br />De kolom ""conversierative"" wordt berekend als de verhouding van het aantal sessies waar een bestelling is geplaatst en de termen waarnaar is gezocht op het totaal aantal sessies waarnaar de termen(s) werden gezocht."

src/module-elasticsuite-analytics/view/adminhtml/templates/search/usage/terms.phtml

@@ -51,6 +51,9 @@ $hiddenTermsData    = array_slice($termsData, $maxVisibleTerms);
                 <tr>
                     <th class="data-grid-th no-link col-search-query"><span><?= __('Term');?></span></th>
                     <th class="data-grid-th no-link"><span><?= __('Sessions');?></span></th>
+                    <th class="data-grid-th no-link"><span><?= __('without clicks');?></span></th>
+                    <th class="data-grid-th no-link"><span><?= __('with clicks');?></span></th>
+                    <th class="data-grid-th no-link"><span><?= __('with submit');?></span></th>
                     <th class="data-grid-th no-link"><span><?= __('Visitors');?></span></th>
                     <th class="data-grid-th no-link <?php if (!$block->getShowConversionRate()) : ?>col-total<?php endif; ?>"><span><?= __('# Results (avg.)');?></span></th>
                     <?php if ($block->getShowConversionRate()) : ?>
@@ -82,6 +85,9 @@ $hiddenTermsData    = array_slice($termsData, $maxVisibleTerms);
                             <?php endif; ?>
                         </td>
                         <td class="col-number"><?= $termData['sessions']; ?></td>
+                        <td class="col-number"><?= $termData['sessions_without_click'] ?? 0; ?></td>
+                        <td class="col-number"><?= $termData['sessions_with_click'] ?? 0; ?></td>
+                        <td class="col-number"><?= $termData['sessions_with_submit'] ?? 0; ?></td>
                         <td class="col-number"><?= $termData['visitors']; ?></td>
                         <td class="col-number"><?= $termData['result_count']; ?></td>
                         <?php if ($block->getShowConversionRate()) : ?>

src/module-elasticsuite-core/view/frontend/web/js/form-mini.js

@@ -276,15 +276,55 @@ define([
 
                         if (this.responseList.indexList.length) {
                             this._updateAriaHasPopup(true);
+                            const productCount = data.filter(item => item.type === 'product').length;
+                            const urlObject = new URL(this.options.url);
+                            const trackingEvent = new CustomEvent(
+                                'elasticsuite:autocomplete',
+                                {
+                                    detail: {
+                                        path: urlObject.pathname,
+                                        queryString: value,
+                                        productCount: productCount
+                                    }
+                                }
+                            );
+                            document.dispatchEvent(trackingEvent);
                         } else {
                             this._updateAriaHasPopup(false);
                         }
 
                         this.responseList.indexList
                             .on('click vclick', function (e) {
                                 self.responseList.selected = $(this);
+
                                 if (self.responseList.selected.attr("href")) {
-                                    window.location.href = self.responseList.selected.attr("href");
+                                    // Find the section header (dt) by going up to the dl parent and finding its dt
+                                    const sectionHeader = self.responseList.selected.closest('dl').find('dt');
+                                    const isProduct = sectionHeader.hasClass('title-product');
+
+                                    // Only dispatch the custom event for products
+                                    if (isProduct) {
+                                        const trackingEvent = new CustomEvent(
+                                            'elasticsuite:autocomplete:product_click',
+                                            {
+                                                detail: {
+                                                    href: self.responseList.selected.attr("href"),
+                                                    text: self.responseList.selected.find('.product-name').text(),
+                                                    queryString: self.element.val()
+                                                },
+                                                bubbles: true,
+                                                cancelable: true
+                                            }
+                                        );
+
+                                        document.dispatchEvent(trackingEvent);
+                                    }
+
+                                    const href = self.responseList.selected.attr("href");
+                                    setTimeout(function() {
+                                        window.location.href = href;
+                                    }, 100);
+
                                     e.stopPropagation();
                                     return false;
                                 }