Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel3
typeflat

...

Overview

The following operations allow you to work with categories. Click an operation name to see details on how to use it.

For a sample proxy service that illustrates how to work with categories, see Sample configuration

OperationDescription

1Working with Categories in DisqusgetCategoryDetails

Returns category details.

1Working with Categories in DisquslistCategoriesReturns a list of categories.

Operation details

This section provides further details on the operations related to categories.

Anchor
getCategoryDetails
getCategoryDetails
Returning category details

The getCategoryDetails operation returns category details.

Code Block
languagexml
titlegetCategoryDetails
<disqus.getCategoryDetails>
	<categoryId>{$ctx:categoryId}</categoryId>
</disqus.getCategoryDetails>
Properties
  • categoryId: The ID of the category to retrieve.
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the getCategoryDetails operation.

Code Block
languagexml
titleSample Request for getCategoryDetails
{
    "categoryId": "3329663",
    "apiUrl": "https://disqus.com",
    "apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu"
}
Related Disqus documentation

https://disqus.com/api/docs/categories/details/

Anchor
listCategories
listCategories
Returning a list of categories

The listCategories operation returns a list of categories within a forum. 

Code Block
languagexml
titlelistCategories
<disqus.listCategories>
    <forumId>{$ctx:forumId}</forumId>
    <limit>{$ctx:limit}</limit>
    <order>{$ctx:order}</order>
    <cursor>{$ctx:cursor}</cursor>
	<sinceId>{$ctx:sinceId}</sinceId>
</disqus.listCategories>
Properties
  • forumId: The ID of the Disqus forum to retrieve.
  • limit: The maximum number of posts to return.
  • order: The order of entries returned: "ASC" or "DESC" (default).
  • cursor: The pagination parameter.
  • sinceId: Returns categories created since the given date ID.
Sample request

Following is a sample REST/JSON request that can be handled by the listCategories operation.

Code Block
languagexml
titleSample Request for listCategories
{
    "limit": "10",
    "sinceId": "3360607",
    "cursor": "",
    "order": "desc",
    "forumId": "java-ee-forum,palaforum",
    "apiUrl": "https://disqus.com",
    "apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu"
}
Related Disqus documentation

https://disqus.com/api/docs/categories/list/

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

Following is a sample proxy service that illustrates how to connect to Disqus with the init operation and use the getCategoryDetails operation. The sample request for this proxy can be found in the getCategoryDetails sample request. You can use this sample as a template for using other operations in this category.

...