Event for viewed federated search result

Overview

This API creates an event for viewed federated search result.

Note

  • An event for viewing a external web page cannot be created for a portal where the value for the "Include Web Search Section in Search Results" attribute is "Yes".
  • An event for viewing a internal web page cannot be created for a portal where the value for the "Include Intranet Search Section in Search Results" attribute is "Yes".

Request Body

For this API to work successfully following attributes must be provided in the request body

  • searchString
  • resultType
  • url
  • language
  • title
SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
header Parameters
Content-Type
required
string
Default: application/json

Media type sent by the client.

Enum: "application/json" "application/xml" "application/x-www-form-urlencoded" "multipart/form-data" "text/plain"
Accept-Language
required
string
Default: en-US

Language locale accepted by 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"
X-egain-tenant-id
string

Unique identifier for tenant.

X-egain-activity-id
integer

Numeric unique identifier of interaction from eGain.

X-interaction-id
string

Unique identifier for interaction from other CRM applications.

Request Body schema: application/json
searchString
string
object
url
string
title
string
object
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

post/portals/{portalID}/search/federated/event
Request samples
application/json
{
  • "searchString": "India",
  • "resultType": {
    },
  • "url": "https://beetle.egain.com/",
  • "title": "Welcome to India",
  • "language": {
    }
}
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>"
}