Get Tag Categories for Interest for a Portal

Overview

This API allows to retrieve the Tag Categories for Interest configured for a portal.

Note

  • Tags that are included within a tag group will be returned in the corresponding tag group node, rather than at the tag category level.
  • Tags that are not associated with any tag group will be returned at the tag category level.

    Response: Sorting and order of objects

  • Tag Categories are ordered in order of their addition in the "Tag Categories for Interest" in the Portal configuration.
  • Tags are ordered as per their order defined in their Tag Category.
  • Tag Groups are sorted by their name, in ascending order.
SecurityoAuthUser or oAuthCustomer or oAuthAnonymousCustomer
Request
path Parameters
portalID
required
number
Example: 202200000001001
query Parameters
$lang
required
string

The knowledge base language used for retrieving response. Must be a language accessible to user.

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
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

204

When no Tag Categories for Interest are configured for a Portal.

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not acceptable

500

Internal server error

get/portals/{portalID}/tagcategoriesforinterest
Request samples
Response samples
application/json
{
  • "tagCategory": [
    ]
}