Federated Search Event

Event For Viewed Federated Search Result

POST
/knowledge/portalmgr/v4/portals/{portalID}/search/federated/event

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
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Path Parameters

portalID*string

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.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20

Header Parameters

x-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
x-ext-integration-id?string

The 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.

Match^[\w\W]+$
Lengthlength <= 40
x-ext-interaction-id?string

A 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.

Match^[\w\W]+$
Lengthlength <= 40
Content-Type*"application/json"

The media type sent by the client.

Default"application/json"

Value in

  • "application/json"
Accept-Language*string

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

q*string

The search string that was entered by the user

Match^[\w\W]+$
Length1 <= length <= 1024
resultType*string

Only "external" or "internal" allowed

Value in

  • "external"
  • "internal"
url*string
Match^(https?|ftp):\/\/([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,6}(:\d+)?(\/[^\s]*)?$
Length10 <= length <= 2000
title*string
Match^[\w\W]+$
Length1 <= length <= 255
languageCode*KbLanguageCode

A short language code. A list of codes can be found below:

CodeDescription
en-USEnglish (United States)
en-GBEnglish (United Kingdom)
fr-FRFrench (France)
es-ESSpanish (Spain)
it-ITItalian (Italy)
de-DEGerman (Germany)
nl-NLDutch (Netherlands)
pt-BRPortuguese (Brazil)
pt-PTPortuguese (Portugal)
da-DKDanish (Denmark)
sv-SESwedish (Sweden)
ru-RURussian (Russia)
fr-CAFrench (Canada)
zh-CNChinese (Simplified, China)
ja-JPJapanese (Japan)
ko-KRKorean (South Korea)
nn-NONorwegian 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"  }'
Empty