Skip to content
Knowledge APIs
/
/
/
Get Article Ratings

Get Article Ratings

Request

Overview

The Get Article Ratings API returns ratings set for an Article. These ratings help you to assess the quality, helpfulness, or relevance of an article.

Security
oAuthUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfUser(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthOnBehalfOfCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
) or oAuthAnonymousCustomer(Required scopes:
https://api.egain.cloud/auth/kno...
)
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
articleIDstring, [ 7 .. 20 ] characters^[a-zA-Z0-9]{2,4}-\d{4,15}$required

The ID of the Article.

An Article ID is composed of a 2-4 letter prefix followed by a dash and 4-15 digits.

Example:PROD-2996
Query
$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
$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
Headers
x-egain-activity-idstring, [ 4 .. 9 ] characters^[0-9]{4,9}$

A unique numeric interaction identifier from eGain.

Example:59237
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-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
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
GET
/portals/{portalID}/articles/{articleID}/ratings
curl -i -X GET \
  'https://api.egain.cloud/knowledge/portalmgr/v4/portals/PROD-1000/articles/PROD-2996/ratings?%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: 3155180e-0c13-43e9-9c38-e9045bcbf176' \
  -H 'x-ext-interaction-id: 3155180e-0c13-43e9-9c38-e9045bcbf176'

Responses

Success

Bodyapplication/json
articleRatingsArray of objects(ArticleRating)
paginationInfoobject(PaginationInfo)
Response
{
  "articleRatings": [
    { … },
    { … }
  ],
  "paginationInfo": {
    "count": 2,
    "pagenum": 1,
    "pagesize": 10,
    "link": [ … ]
  }
}