---
title: "List top comments within an entire spot"
method: GET
path: "/top-comments-spot"
tags: ["top comments"]
---

# List top comments within an entire spot

`GET /top-comments-spot`

Retrieve the top comments for a Spot ID in a given time period

## Headers

- `x-api-key` string, required
- `x-spot-id` string, required
- `x-count` integer
- `x-interval` 'day' | 'week' | 'month'
- `x-month` integer
- `x-weeks` string
- `x-year` 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.net/openweb/apis/publisher-authentication-api.md) · [All operations](https://skmtc.net/openweb/apis/publisher-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openweb/publisher-authentication-api/versions/73ef93486c3c/schema)