Popular Articles

Get Popular Articles

Request

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.

Security

oAuthUser(Required scopes: ) or oAuthOnBehalfOfUser(Required scopes: ) or oAuthCustomer(Required scopes: ) or oAuthOnBehalfOfCustomer(Required scopes: ) or oAuthAnonymousCustomer(Required scopes: )

Path

portalIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

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.

Example:PROD-1000

Query

$filter[topicId]string, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$

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

Example:$filter[topicId]=PROD-1067

$langstring(languageCode)

The language used for 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.

Enum:"en-US""fr-FR""en-GB""es-ES""it-IT""nl-NL""da-DA""sv-SE""pt-PT""fi-FI"

Example:$lang=en-US

$filter[tags]string, [ 7 .. 2048 ] characters^([a-zA-Z0-9]{2,4}-\d{4,15})(,([a-zA-Z0-9]{2,...

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.

Example:$filter[tags]=PROD-5381

$pagenuminteger, (int64), [ 1 .. 999 ]

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

Default:1

$pagesizeinteger, (int64), [ 1 .. 75 ]

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

Default:10

articleResultAdditionalAttributesArray of strings

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:

Name	Description
id	The ID of the Article.
name	The name of the Article.
articleType	The Article Type and its attributes.
createdBy	The ID, first name, middle name and last name of the user that created the Article.
createdDate	The date that the Article was created.
hasAttachments	True: The Article has one or more attachments. False: The Article does not have any attachments.
languageCode	The language code of the Article language.
modifiedBy	The ID, first name, middle name and last name of the user that last modified the Article.
modifiedDate	The date that the Article was last modified on.
link	The link object, used to retrieve the details of the Article.
versionId	The ID of the Article version that is returned.

Items Enum:"averageRating""customAttributes""description""articleSummary""imageURL""isSubscribed""timesRated""topicBreadcrumb""ownedBy""ownedBy.userName"

Examples:

Single

An additional attribute to be returned.

articleResultAdditionalAttributes=["averageRating"]

Multiple

Additional attributes to be returned.

articleResultAdditionalAttributes=["ownedBy","ownedBy.userName"]

All

All additional attributes to be returned.

articleResultAdditionalAttributes=["all"]

Headers

Accept-Languagestringrequired

The Language locale accepted by the 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"

Example:en-US

x-ext-integration-idstring, <= 40 characters^[\w\W]+$

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.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example:59237

x-ext-interaction-idstring, <= 40 characters^[\w\W]+$

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.

Examples:

uuid

3155180e-0c13-43e9-9c38-e9045bcbf176

hex

00Dbn00000IxGnx

GET

/portals/{portalID}/populararticles

curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/populararticles?%24filter%5BtopicId%5D=PROD-1067&%24lang=en-US&%24filter%5Btags%5D=PROD-5381&%24pagenum=1&%24pagesize=10&articleResultAdditionalAttributes=averageRating' \
  -H 'Accept-Language: en-US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-egain-activity-id: 59237' \
  -H 'x-ext-integration-id: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176'

Responses

Success

Bodyapplication/json

articlesArray of objects(ArticleResult)

Article details

paginationInfoobject(PaginationInfo)

Response

{
  "articles": [
    { … }
  ],
  "paginationInfo": {
    "count": 1,
    "pagenum": 1,
    "pagesize": 10
  }
}