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 ID of the department.
The language that describes the details of a resource. Resources available in different languages may differ from each other.
lang is not passed, then the portal's default language is used.Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
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.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/portals?departmentID=999&%24lang=en-US&%24pagenum=1&%24pagesize=10' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-egain-activity-id: 59237' \
-H 'x-ext-integration-id: string' \
-H 'x-ext-interaction-id: string'{ "portal": [ { … } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 10 } }
The Get All Portals Accessible to User API allows a user to fetch all portals accessible to user across all department.
The language used for fetching the details of a resource. Resources available in different languages may differ from each other.
The Name of the department for which portals are to be fetched
Portal name starting with a specific character are considered to filter the result.
The Name of the template used while creating Short URL.
Objects returned in server response are sorted based on the attribute supplied under $sort.
Default value: name.
Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/myportals?%24lang=en-US&department=service&filterText=master&shortUrlTemplate=silver&%24sort=id&%24order=asc&%24pagenum=1&%24pagesize=25' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "portal": [ { … } ], "paginationInfo": { "count": 1, "pagenum": 1, "pagesize": 25 } }
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.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000?%24lang=en-US' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-egain-activity-id: 59237' \
-H 'x-ext-integration-id: string' \
-H 'x-ext-interaction-id: string'Success
The alphanumeric ID of the portal.
A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.
The default ID of the language for the portal content.
The IETF code of the default language for the portal content.
The date that the portal was created.
The date on which the portal was last modified.
Indicates if Enable Portal Search for Draft and Staging Articles is enabled for the portal.
{ "id": "PZ-9999", "name": "Master Portal", "departmentId": "999", "description": "Automatically created portal allowing access to all published articles", "defaultContentLanguageId": "1", "defaultContentLanguageCode": "en-US", "createdBy": { "id": "1004", "firstName": "pa", "middleName": "", "lastName": "developer", "userName": "pa_Developer" }, "createdDate": "2022-03-09T00:22:14Z", "modifiedBy": { "id": "1004", "firstName": "pa", "middleName": "", "lastName": "developer", "userName": "pa_Developer" }, "modifiedDate": "2023-10-18T16:13:53Z", "isStructuredAuthoringEnabled": false, "isManageDraftVisibilityEnabled": false, "portalSettings": { "isAnnoucementsEnabled": false, "isAgentsSSOEnabled": false, "isAgentsDelegatedAuthenticationEnabled": false, "isPopularArticlesListEnabled": false, "popularArticlesListInfluenceWeight": 10, "popularArticlesListInfluencePeriod": 1, "appendSessionJourneyToEmail": false, "isArticleSuggestionsBeforeEscalationEnabled": false, "isEscalationToEmailEnabled": false, "numberOfSuggestedArticlesBeforeEscalation": 0, "isGHInSearchResultsEnabled": false, "webSearchDomain": "", "intranetSearchURL": "", "questionMatchingEngineURL": "", "isCaptchaEnabled": false, "captchaSiteKey": "", "isArticleSharingEnabled": false, "tagCategoriesForSearchFilter": { … }, "maxWebSearchResults": 5, "maxIntranetSearchResults": 5, "isSearchAutocompleteEnabled": true, "isWebSearchEnabled": false, "isIntranetSearchEnabled": false, "isCustomAttributesFilteringEnabled": true, "isSpellcheckEnabled": true, "searchLearningInclusionThreshold": 5, "searchLearningInfluence": 0, "searchLearningMaxInfluence": 300, "searchLearningLevel": 0, "searchRelatedTermsMinResultsThreshold": 10, "searchRelatedTermWeight": 0.25, "customAttributesForSearchFilter": [], "isGHEnabled": false, "isGHStartupQuestionsBeforeUnansweredQuestionsEnabled": true, "isGHDetailsForSearchEnabled": false, "isGHShortNameInSearchEnabled": false, "GHFailureSuccessThreshold": 0, "maxGHAnsweredQuestions": 10, "maxGHUnansweredQuestions": 10, "maxGHSearchResults": 0, "isGHResultsShownOnSuccessfulSearch": false, "isGHControlActionDiagnosticsEnabled": false, "isGHClusterScopeDiagnosticsEnabled": false, "isRelatedArticlesEnabled": true, "isArticleFeedbackEnabled": true, "isArticleFeedbackCommentsEnabled": false, "isArticleFeedbackSummaryEnabled": false, "isRelatedArticlesInSameTopicEnabled": true, "isAuthenticationRequired": true, "isArticleSuggestionsEnabled": true, "isMySuggestionsEnabled": true, "customerProfileAttributes": { … } }, "kbLanguages": { "kbLanguage": [ … ] }, "link": { "rel": "self", "href": "/knowledge/portalmgr/v4/portals/PZ-9999?departmentId=999&%24lang=en-US" } }
The Get Tag Categories for Interest for a Portal API retrieves the Tag Categories for Interest configured for a portal.
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.
curl -i -X GET \
'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/tagcategoriesforinterest?%24lang=en-US' \
-H 'Accept-Language: en-US' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'x-egain-activity-id: 59237' \
-H 'x-ext-integration-id: string' \
-H 'x-ext-interaction-id: string'{ "tagCategory": [ { … } ] }