General Parameters

The following parameters must or can be passed on with each call.

Parameter		Description
id	essential	ID of the item for which information is to be sent. If you are using several ID fields (product ID, version ID, EAN, ISBN, etc.) please talk to FactFinder about the value to be passed on at this point.
masterId	essential if deduplication is used	If your shop contains item versions and you need to transmit the item version number with the id parameter, you will need to transmit the master item number via this parameter to ensure that products and possible events can be assigned to each other.
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 logfile analysis (click-through-rate, search-to-cart-rate, conversion rate etc.). If you are planning on using personalization, you have to supply 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; you can also transmit an empty string or omit the parameter.
userId	essential	Use this to pass a user identifier. As with the session ID, this must be anonymized. The user identifier differs from the sid in that it remains the same for users who visit more than once. Use of this parameter is mandatory for the login event if the Personalization module is being used.

REST

The technical documentation of the REST-API is contained in the search application itself and can be accessed via [your NG server]/fact-finder/swagger-ui.html . It can be also accessed via the following URL:

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

The interface offers not only the parameter documentation, but also the option to test a query and review the result. The documentation was created with Swagger, you can use Swagger Codegen to generate a client for it and use it for your code.

Tracking Interface documentation can be accessed via the tracking resource.