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 posts. Click an operation name to see details on how to use it.

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

OperationDescription

1Working with Posts in DisqusgetPost

Returns information about a post.

1Working with Posts in DisquslistPostsReturns a list of posts.

Operation details

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

Anchor
getPost
getPost
Returning information about a post

The getPost operation returns information about a post.

Code Block
languagexml
titlegetPost
<disqus.getPost>
    <related>{$ctx:related}</related>
	<postId>{$ctx:postId}</postId>
</disqus.getPost>
Properties
  • related: Related information to return in the response: "forum" and/or "thread".
  • postId: The ID of the post to retrieve.
Anchor
request
request
Sample request

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

Code Block
languagexml
titleSample Request for getPost
{
    "apiUrl": "https://disqus.com",
    "postId": "1649781407",
    "apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu",
    "related": "forum,thread"
}
Related Disqus documentation

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

Anchor
listPosts
listPosts
Returning a list of posts

The listPosts operation returns a list of posts within a forum/category and by users. 

Code Block
languagexml
titlelistPosts
<disqus.listPosts>
    <forumId>{$ctx:forumId}</forumId>
    <categoryId>{$ctx:categoryId}</categoryId>
    <since>{$ctx:since}</since>
    <cursor>{$ctx:cursor}</cursor>
    <limit>{$ctx:limit}</limit>
    <query>{$ctx:query}</query>
    <popular>{$ctx:popular}</popular>
    <interval>{$ctx:interval}</interval>
    <offset>{$ctx:offset}</offset>
    <include>{$ctx:include}</include>
    <order>{$ctx:order}</order>
    <related>{$ctx:related}</related>
    <threadId>{$ctx:threadId}</threadId>
	<userId>{$ctx:userId}</userId>
</disqus.listPosts>
Properties
  • forumId: The ID of the Disqus forum to retrieve.
  • categoryId: The ID of the category whose posts should be retrieved.
  • since: The UNIX time stamp (or ISO date time standard).
  • cursor: The pagination parameter.
  • limit: The maximum number of posts to return.
  • query: The query to filter the lists that are returned as part of the response.
  • popular: Whether to pick the popular posts.
  • interval: The interval of posts, one of: 1h, 6h, 12h, 1d, 3d, 7d, 30d, 60d, or 90d.
  • offset: The offset from the interval.
  • include: The types of posts to include: "unapproved", "approved" (default), "spam", "deleted", "flagged", and/or "highlighted".
  • order: The order of entries returned. Choices: "ASC" or "DESC" (default).
  • related: Specifies related information to include in the response: "forum" and/or "thread".
  • threadId: The ID of the Disqus forum to retrieve.
  • userId: The ID of the user whose posts are to be retrieved.
Info
titleSpecial Notes

The table below explains how the API endpoint is chosen for the listPosts method based on request parameters. Please refer to the specific end points for optional parameters when testing different end points.

Priority

Parameter

EP 1

EP 2

EP 3

EP 4

EP 5

1

popular

"true"

-

-

-

-

2

threadId

*

provided

-

-

-

3

categoryId

*

*

provided

-

-

4

forumId

*

*

*

provided

-

5

userId/accessToken

*

*

*

*

provided

* Will not be considered when deciding even when a value is supplied in the request. In case of optional parameters, they will be added as they are.

EP 1 endpoint:

https://disqus.com/api/3.0/posts/listPopular.json

EP 2 endpoint:

https://disqus.com/api/docs/threads/listPosts.json

EP 3 endpoint:

https://disqus.com/api/docs/categories/listPosts.json

EP 4 endpoint:

https://disqus.com/api/docs/forums/listPosts.json

EP 5 endpoint:

https://disqus.com/api/docs/users/listPosts.json

Sample request

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

Code Block
languagexml
titleSample Request for listPosts
{
    "limit": "10",
    "cursor": "",
    "userId": "",
    "threadId": "3189670846",
    "order": "",
    "interval": "",
    "offset": "",
    "popular": "",
    "accessToken": "",
    "forumId": "",
    "query": "",
    "categoryId": "",
    "apiUrl": "https://disqus.com",
    "since": "",
	"apiSecret":"",
    "apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu",
    "related": "forum,thread",
    "include": ""
}
Related Disqus documentation

https://disqus.com/api/docs/posts/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 getPost operation. The sample request for this proxy can be found in the getPost sample request. You can use this sample as a template for using other operations in this category.

...