Event For Viewed Federated Search Result
Overview
The Federated Search Event API creates an event for federated search results that have been viewed. An event for viewing an:
- External web page cannot be created for a portal where the value for the "Include Web Search Section in Search Results" attribute is "Yes".
- Internal web page cannot be created for a portal where the value for the "Include Intranet Search Section in Search Results" attribute is "Yes".
Authorization
accessToken JWT Bearer Token authentication for API access
In: header
Path Parameters
The ID of the portal being accessed.A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
^[a-zA-Z0-9]{2,4}-\d{4,15}$7 <= length <= 20Header Parameters
A unique numeric interaction identifier from eGain.
^[0-9]{4,9}$4 <= length <= 9The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40A unique interaction identifier from other CRM applications.Note: The x-ext-integration-id and x-ext-interaction-id headers must always be provided together and cannot be supplied independently.The x-egain-activity-id may be provided on its own, or it may be provided along with both x-ext-integration-id and x-ext-interaction-id.
^[\w\W]+$length <= 40The media type sent by the client.
"application/json"Value in
- "application/json"
The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).
Value in
- "en-US"
- "es-ES"
- "fr-FR"
- "it-IT"
- "de-DE"
- "nl-NL"
- "pt-BR"
- "pt-PT"
- "da-DK"
- "ru-RU"
- "fr-CA"
- "zh-CN"
- "ja-JP"
- "ko-KR"
- "sv-SE"
Request Body
application/json
The search string that was entered by the user
^[\w\W]+$1 <= length <= 1024Only "external" or "internal" allowed
Value in
- "external"
- "internal"
^(https?|ftp):\/\/([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,6}(:\d+)?(\/[^\s]*)?$10 <= length <= 2000^[\w\W]+$1 <= length <= 255A short language code. A list of codes can be found below:
| Code | Description |
|---|---|
| en-US | English (United States) |
| en-GB | English (United Kingdom) |
| fr-FR | French (France) |
| es-ES | Spanish (Spain) |
| it-IT | Italian (Italy) |
| de-DE | German (Germany) |
| nl-NL | Dutch (Netherlands) |
| pt-BR | Portuguese (Brazil) |
| pt-PT | Portuguese (Portugal) |
| da-DK | Danish (Denmark) |
| sv-SE | Swedish (Sweden) |
| ru-RU | Russian (Russia) |
| fr-CA | French (Canada) |
| zh-CN | Chinese (Simplified, China) |
| ja-JP | Japanese (Japan) |
| ko-KR | Korean (South Korea) |
| nn-NO | Norwegian Nynorsk (Norway) |
Value in
- "en-US"
- "en-GB"
- "fr-FR"
- "es-ES"
- "it-IT"
- "de-DE"
- "nl-NL"
- "pt-BR"
- "pt-PT"
- "da-DK"
- "sv-SE"
- "ru-RU"
- "fr-CA"
- "zh-CN"
- "ja-JP"
- "ko-KR"
- "nn-NO"
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/search/federated/event" \ -H "x-egain-activity-id: 59237" \ -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \ -H "Content-Type: application/json" \ -H "Accept-Language: en-US" \ -H "Content-Type: application/json" \ -d '{ "q": "India", "resultType": "external", "url": "https://beetle.egain.com/", "title": "Welcome to India", "languageCode": "en-US" }'Get User Milestones GET
## Overview The User Milestones API provides information about the milestones of an agent within the article workflow. This API helps track the progress of articles by grouping them into relevant milestones based on their current stage. For example, an article might go through Knowledge Workflow Stages like Draft, Initial Review, Staging, Final Review and Publish. Articles in the Draft and Initial Review stages are part of the "authoring milestone", while articles in the Staging and Final Review stages are part of the "staging milestone".
Event for Search Using Connectors POST
## Overview The Event for Search Using Connectors API creates an event to initiate a search operation for retrieving content from external sources or integrations within the portal. It allows users to set up search events based on specified criteria.

