Skip to main content
GET
Get community interactions

Authorizations

Authorization
string
header
required

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

Query Parameters

brand_id
integer
required

The conversation's brand ID.

limit
integer
default:100

Number of results to return in a single response.

offset
integer
default:0

The offset of the first result to be returned.

types
enum<string>[]

Comma separated list of types.

Available options:
COMMUNITY_INTERACTION,
FACEBOOK_ADS_COMMENT,
FACEBOOK_COMMENT,
FACEBOOK_CONVERSATION,
INSTAGRAM_ADS_COMMENT,
INSTAGRAM_COMMENT,
INSTAGRAM_CONVERSATION,
TIKTOK_COMMENT,
TWITTER_CONVERSATION,
TWITTER_MENTION,
TWITTER_QUOTE,
TWITTER_RETWEET,
YOUTUBE_COMMENT
tag_ids
integer[]

Comma separated list of tag IDs to filter results by. Condition is AND

source_updated_after
string<date-time>

When the community interaction was updated according to the source platform.

source_updated_before
string<date-time>

When the community interaction was updated according to the source platform.

is_archived
boolean

Whether the community interaction is marked as archived.

is_follow_up
boolean

Whether the community interaction is marked as follow-up.

is_read
boolean

Whether the community interaction is marked as read.

query
string

A text that helps search for relevant records.

multiple_keywords
boolean

Flag to determine if query is a list of comma separated keywords.

media_ids
integer[]

Comma separated list of library media IDs

is_positive
boolean

Is the comment is labeled as positive.

is_neutral
boolean

Is the comment is labeled as positive.

is_negative
boolean

Is the comment is labeled as positive.

is_question
boolean

Is the comment a question.

ticket_id
string

A ticket ID to filter results by with OR condition.

assignee_id
integer

ID of the assigned user

sort
enum<string>

Value to sort results by and the direction.

Available options:
-SOURCE_UPDATED_AT,
RELEVANCE,
SAMPLE,
SOURCE_UPDATED_AT
message_nested_date_filter
boolean

When set to true, the source_updated_after/before filter will be applied to individual messages inside a conversation when performing a search

id
integer

The ID of the specific interaction.

must_include_text
boolean

If the documents searched must have text

Response

OK

data
object[]

Different types of community interactions.

paging
object

Pagination data