List top comments within a specific Conversation

Retrieve the top Conversation comments from all time

Headers
string
required

Unique OpenWeb engagement token

Follow these steps to obtain the engagement token:

  1. From your OpenWeb Admin Dashboard, click Settings.
  2. Under Authentication Tokens, copy the Engagement value.
NOTE: This value must not be exposed to users.

string
required

Unique identifier for the Conversation or thread

Use one of these approaches to obtain this value:

Article Card

  1. From your OpenWeb Admin Panel, click Moderation > Articles.
  2. Search for a comment associated with the Conversation.
  3. On the comment card, click More > Copy conversation ID to clipboard.

Code

  1. Locate the spot ID. Contact your OpenWeb representative if you do not know this value.
  2. Identify the post ID. This is the unique article identifier assigned to the article page when it is created.
  3. Concatenate the spot ID and postID with an underscore
spotID_postID

Comment Card

  1. From your OpenWeb Admin Panel, click Moderation > Comments.
  2. Search for a comment associated with the Conversation.
  3. On the comment card, click More > Copy conversation ID to clipboard.

NOTE: Only one of the x-post-id or x-conversation-id is required. If both values are included in the header, x-post-id will be used and x-conversation-id will be ignored.

string
required

Unique article identifier that is specific to the article page

The ideal post ID has the following characteristics:

  • Aligns with the URL slug (an-article-title) or article ID (14325)
  • Is less than 50 characters, ideally 15 characters
  • Uses a combination of letters, numbers, dashes (-), or hyphens (_)
  • Except for the regex [^\w\s\-\:\.\$\~], does not include special characters

NOTE: Only one of the x-post-id or x-conversation-id is required. If both values are included in the header, x-post-id will be used and x-conversation-id will be ignored.

string
required

Spot ID of the partner

integer
Defaults to 10

Number of comments to return

Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json