---
title: "List top comments within a specific Conversation"
method: GET
path: "/top-comments-conversation"
tags: ["top comments"]
---

# List top comments within a specific Conversation

`GET /top-comments-conversation`

## Request

- Base URL: `https://api.openweb.com/engagement-api`
- URL: `https://api.openweb.com/engagement-api/top-comments-conversation`
- Auth: none declared. Required headers: `x-api-key`, `x-conversation-id`, `x-post-id`, `x-spot-id`

Retrieve the top Conversation comments from all time

## Headers

- `x-api-key` string, required
- `x-conversation-id` string, required
- `x-post-id` string, required
- `x-spot-id` string, required
- `x-count` integer

## Response `200`

Example response

- object
  - `comments` object[]
    - `article_name` string: Title or name of the article
    - `article_url` string: URL of the article
    - `article_img` string: Image associated with the article
    - `content` object[]: Possible properties of the content Properties returned depend the `content.type`.
      - `description` string: Short description of the content
      - `embed` string: HTML tag (`<embed>`) used to embed the media on a page
      - `frameType` string: Defines type of social media format the frame emulates **Possible Values** - `FACEBOOK` - `TWEET`
      - `id` string: Unique identifier for the content
      - `imageId` string: Unique identifier for the image
      - `mediaHeight` number: Height of the media
      - `mediaWidth` number: Width of the media
      - `originalHeight` number: Height dimension of the media before resizing
      - `originalUrl` string: URL for the content
      - `originalWidth` number: Width dimension of the media before resizing
      - `previewHeight` number: Height dimension of the media preview
      - `previewUrl` string: URL of the media preview
      - `previewWidth` number: Width dimension of the media preview
      - `providerUrl` string: URL of the provider
      - `thumbnailHeight` number: Height of the thumbnail
      - `thumbnailUrl` string: URL for the thumbnail
      - `thumbnailWidth` number: Width of the thumbnail
      - `title` string: Title of the content
      - `type` string: Type of content **Possible Values** - `animation` - `frame` - `image` - `link` - `mention` - `text` - `video`
      - `text` string: Raw content of the comment
      - `url` string: URL for the content
      - `userId` string: Unique identifier of a mentioned user
    - `conversation_id` string: Unique identifier for the Conversation or thread
    - `dislike_count` number: Number of dislikes received by the comment
    - `is_featured` boolean: Indicates if the comment is featured
    - `label` object
      - `ids` string[]: Label names
      - `section` string: Section name
    - `like_count` number: Number of likes received by the comment
    - `message_id` string: Unique ID of the comment
    - `message_timestamp` number: Date and time the comment was posted
    - `message_type` string: Type of message This value will always be `comment`.
    - `post_id` string: Unique identifier for the post
    - `replies_count` number: Total number of replies to the comment
    - `spot_id` string: Unique OpenWeb identifier for a property
    - `state` string: Status of the comment **Possible Values** - `approved` - `publish and moderate` - `rejected` - `require approval`
    - `user_id` string: Unique identifier for the commenter
    - `username` string: Username of the commenter
    - `user_profile_picture` string: URL of the profile image of the user

---

[API](https://skmtc.dev/openweb/apis/top-comments-api.md) - [All operations](https://skmtc.dev/openweb/apis/top-comments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openweb/apis/top-comments-api/revisions/82b8d34aa03e?raw)