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".
SecurityoAuthUser or oAuthOnBehalfOfUser or oAuthCustomer or oAuthOnBehalfOfCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
string [ 7 .. 20 ] characters ^[a-zA-Z0-9]{2,4}-\d{4,15}$

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
header Parameters
x-egain-activity-id
string [ 4 .. 9 ] characters ^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

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

The unique numeric identifier for a tenant, used in self-service functionality as well as third-party integrations.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-interaction-id.

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

A unique interaction identifier from other CRM applications.

Note: If x-egain-activity-id is not provided, then this must be passed along with x-ext-integration-id.

Examples:
3155180e-0c13-43e9-9c38-e9045bcbf176
00Dbn00000IxGnx
Content-Type
required
string
Default: application/json

The media type sent by the client.

Value: "application/json"
Accept-Language
required
string

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" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Example: en-US
Request Body schema: application/json
q
required
string [ 1 .. 1024 ] characters ^[\w\W]+$

The search string that was entered by the user

resultType
required
string

Only "external" or "internal" allowed

Enum: "external" "internal"
url
required
string [ 10 .. 2000 ] characters ^(https?|ftp):\/\/([a-zA-Z0-9-]+\.)+[a-zA-Z]{...
title
required
string [ 1 .. 255 ] characters ^[\w\W]+$
languageCode
required
string (KbLanguageCode)

A 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)
Enum: "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"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

415

Incorrect Content Type Header

500

Internal server error

post/portals/{portalID}/search/federated/event
Request samples
application/json
{}
Response samples
application/json

Required query parameter is missing.

{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}