Shop Cachehit
Wenn Ihr Shop einen eigenen Cache verwaltet und Such- bzw. Navigationsanfragen über diesen Cache beantwortet werden, ohne dass die Anfrage an FactFinder weitergeleitet wird, senden Sie bitte das log-Event, um FactFinder über die Anfrage in Kenntnis zu setzen. Dies ist vor allem für die Korrektheit der Analysen, aber auch für Module, deren selbstoptimierende Funktionsweise auf Suchanzahlen basieren (z.B. ASO), wichtig. Sie senden mit diesem Event die wichtigsten Eckdaten des Suchergebnisses, welches aus Ihrem Cache ausgeliefert wurde.
Das log-Event benötigt von den allgemeinen Parametern den event-, sid- und den channel-Parameter. Die zu überliefernde Session-ID ist die Id des Aufrufs, der von Ihrem Cache beantwortet wurde, nicht die Session-ID des Aufrufs, der das gecachte Suchergebnis erzeugt hat. Zudem müssen bzw. können die folgenden Parameter übertragen werden:
| Parameter | Beschreibung | |
|---|---|---|
| query | benötigt | Der Suchbegriff für den das Suchergebnis erzeugt wurde. |
| page | benötigt | Die Nummer der Seite, welche im Suchergebnis zurückgeliefert wurde. Die erste Seite hat die Nummer 1. |
pageSize | benötigt | Die Anzahl Produkte pro Suchergebnisseite in dem Suchergebnis. |
hitCount | benötigt | Die Anzahl der gefundenen Produkte im Suchergebnis. |
searchTime | benötigt | Die Zeit, die benötigt wurde, um das Suchergebnis zu erstellen in ms. |
bestSimi | benötigt | Die Ähnlichkeit des besten Produktes. |
minSimi | benötigt | Die Ähnlichkeit des letzten Produktes. |
filter[FELDNAME] | optional | Informationen über aktive Filter im Suchergebnis. Dieser Parameter besteht aus dem Prefix filter gefolgt von dem Namen des Feldes, auf dem gefiltert wurde. Z.B. filterHersteller. Dieser Parameter kann mehrfach vorhanden sein, da ja mehrere Filter auf verschiedenen Feldern gesetzt sein können. Der Wert dieses Parameters besteht aus dem entsprechenden Filterwert, wobei sich dieser äquivalent zu einem Filterwert einer Suchanfrage zusammensetzt. Bedenken Sie hierbei, dass Sie die genutzten Zeichen für und, oder und nicht pro Channel in der config.xml festlegen können. Der Wert in diesem Parameter muss dieselben Zeichen verwenden, wie die Filter in Ihren Suchanfragen. Haben Sie also beispielsweise ~~~ für oder, ___ für und und ! für nicht gewählt, ergibt sich für einen Filter, der rot oder nicht blau und gelb filtert, folgender Parameterwert: rot~~~!blau___gelb. Es wird beim log-Event nicht zwischen Filtern und Substringfiltern unterschieden. Bitte senden Sie alle aktiven Filter über diesen Parameter. |
searchField | optional | Das Feld, auf dem die Suche ausgeführt wurde, falls die Suche auf ein bestimmtes Feld eingeschränkt wurde. |
customSorting | optional | Falls im Suchergebnis nicht die Standardsortierung verwendet wurde, senden Sie hier bitte ein true. Falls Sie den Parameter nicht senden, geht FactFinder davon aus, dass das Suchergebnis mit der Standardsortierung geordnet wurde. |
additionalInfo | optional | Falls Sie dem Logeintrag noch etwas hinzufügen möchten, beispielsweise um das Log nach speziellen Einträgen durchsuchen zu können, können Sie diesen Parameter verwenden. Hinweis: Im Gegensatz zu den anderen Trackingevents werden |
REST
Die technische Dokumentation der REST-API ist in der Suchanwendung selbst enthalten und kann über folgende URL aufgerufen werden:
Swagger Link
Auf dieser Oberfläche erhalten Sie neben der Parameter-Dokumentation auch die Möglichkeit eine Abfrage zu testen und sich das Ergebnis davon anzuschauen. Da die Dokumentation mit Swagger erstellt worden ist, können sie mit Swagger Codegen einen Client dafür generieren und in Ihrem Code verwenden.
Die Dokumentation des Shop Cachehit-Events befindet sich unter der Methode log der Ressource tracking.