List top comments within a specific Conversation
Retrieve the top Conversation comments from all time
Request
- Base URLhttps://api.openweb.com/engagement-api
- URLhttps://api.openweb.com/engagement-api/top-comments-conversation
- Authnone declared. Required headers: x-api-key, x-conversation-id, x-post-id, x-spot-id
Headers
Unique OpenWeb engagement token<br /><br />Follow these steps to obtain the engagement token:<ol><li>From your OpenWeb Admin Dashboard, click <strong>Settings</strong>.</li><li>Under <strong>Authentication Tokens</strong>, copy the <strong>Engagement</strong> value.</li></ol><strong>NOTE:</strong> This value <strong>must not</strong> be exposed to users.
Unique identifier for the Conversation or thread
Use one of these approaches to obtain this value:
<strong>Article Card</strong>
- From your OpenWeb Admin Panel, click Moderation > Articles.
- Search for a comment associated with the Conversation.
- On the comment card, click More > Copy conversation ID to clipboard.
<strong>Code</strong>
- Locate the spot ID. Contact your OpenWeb representative if you do not know this value.
- Identify the post ID. This is the unique article identifier assigned to the article page when it is created.
- Concatenate the spot ID and postID with an underscore
spotID_postID
<strong>Comment Card</strong>
- From your OpenWeb Admin Panel, click Moderation > Comments.
- Search for a comment associated with the Conversation.
- 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.
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.
Spot ID of the partner
Number of comments to return
Response
Example response
Changes
No recorded changes to this operation across all 1 revision of this API.