# Allgemeine Parameter

Die folgenden Parameter müssen bzw. können bei jedem Aufruf übergeben werden.

| Parameter  |                                                      | Beschreibung                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ---------- | ---------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`       | erforderlich                                         | ID des Artikels, für den Informationen übermittelt werden sollen. Wenn Sie mehrere ID-Felder verwenden (Produkt-ID, Versions-ID, EAN, ISBN usw.), sprechen Sie bitte mit FactFinder darüber, welcher Wert an dieser Stelle übergeben werden soll.                                                                                                                                                                                                                                                                                                                                        |
| `masterId` | erforderlich, wenn **Deduplizierung** verwendet wird | Wenn Ihr Shop Artikelversionen enthält und Sie die Artikelversionsnummer mit dem id-Parameter übermitteln müssen, sollten Sie die Master-Artikelnummer über diesen Parameter übergeben, damit Produkte und mögliche Ereignisse einander zugeordnet werden können.                                                                                                                                                                                                                                                                                                                        |
| `channel`  | erforderlich                                         | Der Name des FactFinder-Channels, in dem die Suche durchgeführt wurde.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `sid`      | erforderlich                                         | <p>Verwenden Sie dies, um die Sitzungskennung des Benutzers zu übergeben. Sie wird für Logfile-Analysen (Click-Through-Rate, Search-to-Cart-Rate, Conversion-Rate usw.) verwendet.</p><blockquote><p>Wenn Sie Personalisierung planen, müssen Sie diesen Parameter für alle Tracking-Ereignisse (und für Suchen!) übergeben.</p></blockquote>                                                                                                                                                                                                                                            |
| `event`    | erforderlich                                         | <p>Dieser Parameter legt den Ereignistyp fest. Verwenden Sie für die verschiedenen Typen bitte die folgenden Werte:</p><ul><li><code>click</code> – Klick auf das Produkt oder den Link zur Detailseite</li><li><code>cart</code> – Produkt in den Warenkorb gelegt</li><li><code>checkout</code> – Produkt gekauft</li><li><code>login</code> – Benutzer meldet sich an</li><li><code>recommendationClick</code> – Klick auf ein vom Recommendation Engine vorgeschlagenes Produkt</li><li><code>feedback</code> – Kommentar zum Suchergebnis, hinterlassen vom Shop-Besucher</li></ul> |
| `title`    | erforderlich                                         | Der Artikelname. Dieser Wert ist optional; Sie können auch einen leeren String übermitteln oder den Parameter weglassen.                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `userId`   | erforderlich                                         | Verwenden Sie dies, um eine Benutzerkennung zu übergeben. Wie bei der Sitzungs-ID muss diese anonymisiert sein. Die Benutzerkennung unterscheidet sich vom `sid` darin, dass sie für Benutzer, die mehrmals besuchen, gleich bleibt. Die Verwendung dieses Parameters ist zwingend für das `login` Ereignis, wenn das Personalisierungsmodul verwendet wird.                                                                                                                                                                                                                             |

## REST

Die technische Dokumentation der REST-API befindet sich in der Suchanwendung selbst und kann über \[Ihr NG-Server]/fact-finder/swagger-ui.html aufgerufen werden. Sie ist außerdem über die folgende URL erreichbar:

Swagger-Link: <https://ng-demo.fact-finder.de/fact-finder/swagger-ui.html>

Die Schnittstelle bietet nicht nur die Parameterdokumentation, sondern auch die Möglichkeit, eine Abfrage zu testen und das Ergebnis zu prüfen. Die Dokumentation wurde mit Swagger erstellt; Sie können Swagger Codegen verwenden, um einen Client dafür zu generieren und in Ihrem Code zu nutzen.

Auf die Tracking-Interface-Dokumentation kann über das `tracking` Ressource zugegriffen werden.