Integrating Feedback Campaign

Display feedback text and pushed products returned by feedback campaigns in the right place.

Feedback campaigns let you return text or products to the shop as “feedback.” These campaigns use the type, or flavour, FEEDBACK.

Feedback Text

Earlier FactFinder versions managed this kind of variable content with numeric identifiers. The integration project defined where each feedback text number appeared on the shop page. For example, feedback text number 3 might have been placed above the search results [1].

Since version 6.7, feedback texts use names instead.

For current integrations, use those names as identifiers.

[1]

“Above the search results” in this instance really is simply an example. The position of the feedback text can be selected by the shop operator in the integration project.

The names are agreed with the shop operator during the integration project and then configured in FactFinder. In the user interface, users can select from those predefined names. You can also define whether each feedback text may contain HTML. FactFinder returns this property together with the feedback text, so your integration can decide whether the text should be HTML-escaped [2].

[2]

The default value for the HTML attribute is false. If the HTML attribute is not specified, this means that the feedback text may not contain HTML and must therefore be escaped.

REST interface

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

The relevant methods are documented under records. 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.

Please use the campaign method to retrieve campaigns.

Pushed Products

You can assign products to Feedback Campaigns. FactFinder returns the product list with the campaign.

The product list entries each contain the complete field list from the product record in the FactFinder database. However, in order to save bandwidth you can also pass the parameters idsOnly=true with the search request. In this case the content of the records is omitted.

A campaign can also be returned with 0 products. Users can choose to integrate campaign products directly into the search results. In that case, no separate campaign product list is returned. The campaign itself is still returned so the shop knows that the search query triggered it.