Popular Articles

Get Popular Articles

GET
/knowledge/portalmgr/v4/portals/{portalID}/populararticles

Overview

The Popular Articles API allows a user to retrieve popular articles.

Prerequisites

* Only displayable articles are returned. An Article is displayable when "Include in browse on portals" property is enable for the Article.

Permissions

  • Agent permissions: The following permissions are required if user is an Agent:
    • If Article has Access Tags, Article must be available for agent's current user profile.
    • If Article has Publish Views, at least one edition of Article must be available for agent's current user profile.
    • If Article has filters and tags query parameter provided, Article filters must match provided tags or tag groups.
  • Customer permissions: The following permissions are required if user is a Customer:
    • If Article has Access tags:
    • Portal must have default user profile, and;
    • Article must be available for portal's default user profile.
    • If Article has Publish Views:
      • Portal must have default user profile, and;
      • At least one edition must be available for portal's default user profile.
    • If Article has filters and tags query parameter provided, Article filters must match provided tags or tag groups.

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

Query Parameters

$filter[topicId]?string

The ID of the topic. It is used to restrict to a specific topic.

Match^[a-zA-Z0-9]{2,4}-\d{4,15}$
Length7 <= length <= 20
$lang?string

The language that describes the details of a resource. Resources available in different languages may differ from each other.If lang is not passed, then the portal's default language is used.

Value in

  • "en-US"
  • "fr-FR"
  • "en-GB"
  • "es-ES"
  • "it-IT"
  • "nl-NL"
  • "da-DA"
  • "sv-SE"
  • "pt-PT"
  • "fi-FI"
  • "no-NB"
  • "no-NN"
  • "ja-JA"
  • "de-DE"
  • "pt-BR"
  • "zh-CN"
  • "zh-TW"
  • "ko-KO"
  • "ru-RU"
  • "el-EL"
  • "tr-TR"
  • "pl-PL"
  • "cs-CS"
  • "sk-SK"
  • "hu-HU"
  • "sr-SR"
  • "ar-SA"
  • "hr-HR"
  • "ro-RO"
  • "th-TH"
  • "de-AT"
  • "vi-VN"
  • "id-ID"
  • "ms-MY"
  • "fil-PH"
  • "fr-CA"
  • "hi-IN"
  • "uk-UA"
  • "bg-BG"
  • "sl-SI"
  • "xx-XX"
$filter[tags]?string

A comma separated list of Tag / Tag Group IDs. The query results will be filtered by the tags that are specified.Tag IDs and Tag Group IDs can be mixed together.

Match^([a-zA-Z0-9]{2,4}-\d{4,15})(,([a-zA-Z0-9]{2,4}-\d{4,15})){0,19}$
Length7 <= length <= 2048
$pagenum?integer

Pagination parameter that specifies the page number of results to be returned. Used in conjunction with $pagesize.

Formatint64
Range1 <= value <= 999
Default1
$pagesize?integer

Pagination parameter that specifies the number of results per page. Used in conjunction with $pagenum.

Formatint64
Range1 <= value <= 75
Default10
articleResultAdditionalAttributes?array<>

The attributes of an Article to be returned in addition to the default list of attributes, listed below. Multiple additional attributes can be specified using a comma-separated list. Passing 'all' will return all attributes.

Default Attributes

These Article attributes are always returned:

NameDescription
idThe ID of the Article.
nameThe name of the Article.
articleTypeThe Article Type and its attributes.
createdByThe ID, first name, middle name and last name of the user that created the Article.
createdDateThe date that the Article was created.
hasAttachmentsTrue: The Article has one or more attachments.False: The Article does not have any attachments.
languageCodeThe language code of the Article language.
modifiedByThe ID, first name, middle name and last name of the user that last modified the Article.
modifiedDateThe date that the Article was last modified on.
linkThe link object, used to retrieve the details of the Article.
versionIdThe ID of the Article version that is returned.

Header Parameters

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/knowledge/portalmgr/v4/portals/PROD-1000/populararticles?%24filter%5BtopicId%5D=PROD-1067&articleResultAdditionalAttributes=averageRating" \  -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"

{  "articles": [    {      "id": "PROD-2996",      "name": "Fair Lending FAQs",      "createdBy": {        "id": "1013",        "firstName": "John",        "middleName": "",        "lastName": "Doe"      },      "createdDate": "2022-06-30T14:54:55Z",      "hasAttachments": true,      "languageCode": "en-US",      "modifiedBy": {        "id": "1013",        "firstName": "John",        "middleName": "",        "lastName": "Doe"      },      "modifiedDate": "2025-01-28T19:53:58Z",      "link": {        "rel": "self",        "href": "/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996?filter%5Btopic%5D=PROD-1069&workflowMilestone=publish&%24lang=en-US"      },      "versionId": "PROD-2884"    }  ],  "paginationInfo": {    "count": 1,    "pagenum": 1,    "pagesize": 10  }}