The following licenses are required to use the Knowledge Access APIs:
| Tier | Tier Name | Named Users | Description |
|---|---|---|---|
| Tier 1 | Starter | Up to 10 | Designed for small-scale implementations or pilot environments |
| Tier 2 | Growth | Up to 1000 | Suitable for mid-scale deployments requiring moderate scalability |
| Tier 3 | Enterprise | Greater than 1000 | Supports large-scale environments with extended configuration options |
The following Resources have predefined limits for specific access attributes for Starter, Growth and Enterprise use.
| Resource | Limits | Starter | Growth | Enterprise |
|---|---|---|---|---|
| Article Reference | Number of attachments used in any article | 25 | 50 | 50 |
| Number of custom attributes in an article | 10 | 25 | 50 | |
| Number of publish views used in an article version | 20 | 20 | 20 | |
| Topic Reference | User-defined topics in a department | 1000 | 5000 | 50000 |
| Depth of topics | 5 | 20 | 20 | |
| Topics at any level | 500 | 2500 | 2500 | |
| Number of custom attributes in a topic | 10 | 10 | 10 | |
| Portal Reference | Tag categories in a portal | 15 | 15 | 15 |
| Topics to be included in a portal | 100 | 500 | 5000 | |
| Number of articles to display in announcements | 10 | 25 | 25 | |
| Usage links and link groups setup for a portal | 5 | 10 | 25 |
The Federated Search Event API creates an event for federated search results that have been viewed. An event for viewing an:
A unique numeric interaction identifier from eGain.
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.
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.
The media type sent by the client.
The search string that was entered by the user
Only "external" or "internal" allowed
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) |
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: string' \
-H 'x-ext-interaction-id: string' \
-d '{
"q": "India",
"resultType": "external",
"url": "https://beetle.egain.com/",
"title": "Welcome to India",
"languageCode": "en-US"
}'