General Parameters

Reference the common tracking parameters required for FactFinder tracking events.

The following parameters are required or optional for each call.

Parameter		Description
id	essential	ID of the item for which information is sent. If you use several ID fields, such as product ID, version ID, EAN, or ISBN, check with FactFinder which value should be passed here.
masterId	essential if deduplication is used	If your shop contains item variants and you send the variant ID through the id parameter, also send the master item number here. This ensures that products and related events can be linked correctly.
channel	essential	The name of the FactFinder channel in which the search was conducted.
sid	essential	Use this to pass the user’s session identifier. It is used for log analysis, such as click-through rate, search-to-cart rate, and conversion rate. If you plan to use personalization, pass this parameter for all tracking events and for searches.
event	essential	This parameter specifies the event type. Please use the following values for the various types: click – Click on the product or link to the details page cart – Product placed in the shopping basket checkout – Product purchased login – User logs in recommendationClick – Click on a product suggested by the Recommendation Engine feedback – Comment on the search result left by the shop visitor
title	essential	The item name. This value is optional in practice. You can also send an empty string or omit the parameter.
userId	essential	Use this to pass a user identifier. Like the session ID, it must be anonymized. Unlike sid, it stays the same when a user returns. This parameter is required for the login event if the Personalization module is used.

REST

The REST API documentation is part of the search application and is available at [your NG server]/fact-finder/swagger-ui.html. You can also access it here:

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

In addition to the parameter documentation, you can test requests and inspect the results directly. Because the documentation is built with Swagger, you can also use Swagger Codegen to generate a client.

Tracking interface documentation is available under the tracking resource.