Skip to main content
GET
Get a comment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

community_interaction_id
integer
required

The ID of the comment

Required range: x >= 0

Query Parameters

return_parent
boolean

Additionally return the parent comment or the just the comment itself.

Response

OK

instagram_parent_comment_id
string
required

The parent comment's ID provided by Instagram.

is_ad_comment
boolean
required

Whether the comment is from ads.

text
string
required

The comment body.

assignee_id
integer
read-only

The ID of the user to whom the interaction is assigned.

author_profile_picture_url
string | null
read-only

The profile picture URL of the author.

author_username
string | null
read-only

The handle of the author.

brand_id
integer
read-only

The community interaction's brand ID.

brand_user_reply
object | null

Brand user that created the reply.

comment_count
integer

The total number of comments on the Instagram post.

created_at
string<date-time>
read-only

When the comment was created.

id
integer
read-only

The comment's ID.

instagram_comment_id
string
read-only

The comment's ID provided by Instagram.

instagram_created_at
string<date-time>
read-only

The creation timestamp of the Instagram post.

instagram_username
string | null

The instagram handle of the author.

is_archived
boolean
read-only

Whether the community interaction is marked as archived.

is_author_blocked
boolean
read-only

Whether the user is blocked.

is_follow_up
boolean
read-only

Whether the community interaction is marked as follow-up.

is_hidden
boolean
default:false

Whether the comment is marked as hidden.

is_owned
boolean
default:false

Whether the brand posted this comment.

is_read
boolean
read-only

Whether the community interaction is marked as read.

media_comment_sentiment
object

The overall sentiment of the post's comments.

media_id
integer
read-only

The ID of the media the comment was made on.

media_type
enum<string>
read-only

The media type of the post.

Available options:
CAROUSEL_ALBUM,
IMAGE,
REELS,
SHORTS,
VIDEO
post_media
object | null

Info about the media the comment was made on.

post_thumbnail_url
string
read-only

The image thumbnail url of the original post.

replies
object[]
read-only

A list of replies to the this comment.

search_result_snippet
string
read-only

Indicates how many messages match the query.

sentiment
object

The comment sentiment.

source_updated_at
string<date-time>
read-only

When the comment was created.

tag_ids
integer[]

List of tag IDs associated with the community interaction.

tickets
object[]
read-only

The tickets created for this community interaction.

type
enum<string>
read-only

The community interaction type.

Available options:
COMMUNITY_INTERACTION,
FACEBOOK_COMMENT,
FACEBOOK_CONVERSATION,
INSTAGRAM_COMMENT,
INSTAGRAM_CONVERSATION,
TIKTOK_COMMENT,
TWITTER_CONVERSATION,
TWITTER_MENTION,
TWITTER_QUOTE,
TWITTER_RETWEET,
YOUTUBE_COMMENT
updated_at
string<date-time>
read-only

The last time the comment was updated.