With the Federated Search API, you can unify external content into your the search results displayed on your community.
Federated search via API is a paid add on. Please contact your CSM to start using it.
How do federated search results appear in your community search?
Live search dropdown
The results from the federated search appear in a section below the community results. If you integrate content from different sources, they will each have a different section in the live search dropdown.
You can use phrases to name that section.
Search result page
The results from the federated search appear in the list of results. A filter on the left allows to display only results from different sources of the federated search.
How do I set up a federated search integration through the API?
Note: You will need the help of a developer to use this API and integrate federated content. Alternatively, you can reach out to your CSM to discuss options of our Professional Services team helping you build this integration.
Access the API documentation:
- Europe: https://api2-eu-west-1.insided.com/docs/search/
- USA: https://api2-us-west-2.insided.com/docs/search/
Check out this KB article to learn how to access our API
You can decide to implement the integration in two different ways:
- Either the federated content gets updated at defined frequency. For example once a day the content is synchronised. So if you delete one URL, it will still appear as a search result for a few hours. This first option is usually the simplest to implement.
- Either the federated content gets updated in real time. So as soon as a URL is deleted for instance it will not show up anymore in the search results. This option is usually more complex to implement
Frequently asked questions:
How do I add the source for a federated search integration, so we can differentiate these in our search results?
You need to add ‘source’ to the payload through the API (see example below). After that, it will show the source you entered there (i.e. externalAcademy) as a category in the search results. You can then use Phrases to change that name to a friendly name (i.e. Academy).
How much external content can I federate in my search results?
You can federate up to 10,000 records. One record equals to one search result.
Can I federate content from different languages?
Yes, you can add any content, no matter the language.
Will the federated content appear in the Embeddable widget?
No, the search in the Embeddable widget will not show any federated content. The Embeddable widget will only show Community content and Knowledge base content).
Will the federated content appear in the topic creation form in the "Related topics" section?
No, the "Related topics" section will only show community topics.