Working with Posts in Disqus

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.

Operation	Description
getPost	Returns information about a post.
listPosts	Returns a list of posts.

Operation details

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

Returning information about a post

The getPost operation returns information about a post.

getPost

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

Sample request

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

Sample Request for getPost

{
    "apiUrl": "https://disqus.com",
    "postId": "1649781407",
    "apiKey": "hNCiYG7sBpsyavTbpysXNgHKJ8YDb9IFr3LpcVGj3eEZTPCicTJxNBoHub4etovu",
    "related": "forum,thread"
}

Returning a list of posts

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

listPosts

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

The table below explains which Disqus API method (endpoint) is used for the listPosts operation based on the request properties. For example, if popular is set to true, https://disqus.com/api/3.0/posts/listPopular.json will always be used to process the request. If popular is set to false, and the threadId is provided, https://disqus.com/api/docs/threads/listPosts.json will be used regardless of whether values are provided for categoryId, forumId, and userId/accessToken, and if threadId is not provided but categoryId is provided, https://disqus.com/api/docs/categories/listPosts.json will be used regardless of whether values are provided for forumId and userId/accessToken.

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 even when a value is supplied in the request.

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.

Sample 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": ""
}

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.

Sample Proxy

<?xml version="1.0" encoding="UTF-8"?>
<proxy name="disqus_getPost" startOnLoad="true" statistics="disable" trace="disable" transports="https,http" xmlns="http://ws.apache.org/ns/synapse">
    <target>
        <inSequence onError="faultHandlerSeq">
            <property name="apiUrl" expression="json-eval($.apiUrl)"/>
            <property name="apiKey" expression="json-eval($.apiKey)"/>
            <property name="apiSecret" expression="json-eval($.apiSecret)"/>
            <property name="accessToken" expression="json-eval($.accessToken)"/>
            <property name="related" expression="json-eval($.related)"/>
            <property name="postId" expression="json-eval($.postId)"/>
            <disqus.init>
                <apiUrl>{$ctx:apiUrl}</apiUrl>
                <apiKey>{$ctx:apiKey}</apiKey>
                <apiSecret>{$ctx:apiSecret}</apiSecret>
                <accessToken>{$ctx:accessToken}</accessToken>
            </disqus.init>
            <disqus.getPost>
                <related>{$ctx:related}</related>
                <postId>{$ctx:postId}</postId>
            </disqus.getPost>
            <respond/>
        </inSequence>
        <outSequence>
            <send/>
        </outSequence>
    </target>
    <description/>
</proxy>

Overview

Operation details

Returning information about a post

Properties

Sample request

Related Disqus documentation

Returning a list of posts

Properties

Sample request

Related Disqus documentation

Sample configuration