Connectors Search Events

Event for Viewed Search Results Using Connectors

POST
/knowledge/portalmgr/v4/portals/{portalID}/view/searchresults/connectors/event

Overview

The Event for Viewed Search Results Using Connectors API creates an event to log when search results from external content are viewed. This helps in tracking and analyzing user interactions with search results retrieved from various external sources.

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

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"
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-egain-activity-id?string

A unique numeric interaction identifier from eGain.

Match^[0-9]{4,9}$
Length4 <= length <= 9
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

Request Body

application/json

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"
q*string

The string to use for the search.

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

The URL of the search result.

Match^(https?|ftp):\/\/([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,6}(:\d+)?(\/[^\s]*)?$
Length10 <= length <= 2000
title*string

The title of the search result.

Match^[\w\W]+$
Length1 <= length <= 255

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/view/searchresults/connectors/event" \  -H "Content-Type: application/json" \  -H "Accept-Language: en-US" \  -H "x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "x-egain-activity-id: 59237" \  -H "x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176" \  -H "Content-Type: application/json" \  -d '{    "languageCode": "en-US",    "q": "India",    "url": "https://beetle.egain.com/",    "title": "Welcome to India"  }'
Empty