Skip to content
Knowledge APIs
/
Portal Manager
/
/Federated Search Event

Federated Search Event

Federated Search Event API

Operations

Event For Viewed Federated Search Result

Request

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".
Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthAnonymousCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
Path
portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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.

Example:PROD-1000
Headers
x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example:59237
x-ext-integration-idstring, <= 40 characters^[\w\W]+$

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.

Examples:
uuid
3155180e-0c13-43e9-9c38-e9045bcbf176
hex
00Dbn00000IxGnx
x-ext-interaction-idstring, <= 40 characters^[\w\W]+$

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.

Examples:
uuid
3155180e-0c13-43e9-9c38-e9045bcbf176
hex
00Dbn00000IxGnx
Content-Typestringrequired

The media type sent by the client.

Default:"application/json"
Value:"application/json"
Accept-Languagestringrequired

The Language locale accepted by the client (used for locale specific fields in resource representation and in error responses).

Enum:"en-US""es-ES""fr-FR""it-IT""de-DE""nl-NL""pt-BR""pt-PT""da-DK""ru-RU"
Example:en-US
Bodyapplication/jsonrequired
qstring, [ 1 .. 1024 ] characters^[\w\W]+$required

The search string that was entered by the user

Example:"India"
resultTypestringrequired

Only "external" or "internal" allowed

Enum:"external""internal"
Example:"external"
urlstring, [ 10 .. 2000 ] characters^(https?|ftp):\/\/([a-zA-Z0-9-]+\.)+[a-zA-Z]{...required
Example:"https://egain.com/"
titlestring, [ 1 .. 255 ] characters^[\w\W]+$required
Example:"Welcome to eGain"
languageCodestring(languageCode)required

The language of a resource. Resources available in different languages may differ from each other.

Enum:"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"
Example:"en-US"
POST
/portals/{portalID}/search/federated/event
curl -i -X POST \
  https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/search/federated/event \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -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' \
  -d '{
    "q": "India",
    "resultType": "external",
    "url": "https://beetle.egain.com/",
    "title": "Welcome to India",
    "languageCode": "en-US"
  }'

Responses

No Content

Response
No content