Get popular articles

Overview

  • This API allows a user to retrieve popular articles.
  • Only those popular articles will be returned which are displayable. An article is displayable if 'Include in browse on portals' property of the article type is set as yes.

Permission

  • 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 is provided, article filters must match provided tags or tag groups.
  • 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 is provided, article filters must match provided tags or tag groups.
SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
query Parameters
topicId
number

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

Example: topicId=202200000001037
$lang
string

The knowledge base language used for retrieving the response. This must be a language that is made available to the user. If this parameter is not passed, then the default language of the system is used.

Enum: "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"
Example: $lang=en-US
filter[tags]
string

A comma separated list of Tag / Tag Group IDs. Tag IDs and Tag Group IDs can be mixed together.

Example: filter[tags]=202200000001177,202200000001185
$pagenum
string

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

$pagesize
string

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

$rangestart
string

Range parameter that specifies the starting index of the range of results to be returned. Used in conjunction with $rangesize.
Default value: 1

$rangesize
string

Range parameter that specifies the number (range) of results to be returned. Used in conjunction with $rangestart.
Default value: 10

$attribute
string

The fields of the article to be returned.

Enum: "articleMacro" "availabilityDate" "averageRating" "contentText" "suggestionType" "timesRated" "availableEditions" "articleTypeAttributes" "milestone" "all"
Example: $attribute=milestone
header Parameters
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.

Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/dfaq
Request samples
Response samples
application/json
{
  • "article": [
    ],
  • "paginationInfo": {
    }
}