For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integrating Advisor Campaigns

Handle advisor campaigns by displaying active questions, answers, and the underlying question tree.

These are campaigns where the flavour attribute is set to ADVISOR. Advisor campaigns contain two sections in the response:

  • The first section contains the active questions and associated answers.

  • The second section contains the full question-and-answer tree. The active questions are the ones currently shown to the shop visitor. Because the campaign is structured as a tree, the active section initially contains the first question in that tree.

When the user selects an answer, the follow-up questions below that answer are returned as active questions.

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.

Last updated

Was this helpful?