Engage
What the brand itself published: the comments it posted, by the kind of content they were posted on, with the likes and replies they drew. Takes the same brand, platform and date window as Analytics.
Get Comment Statistics
/api/v1/engage/comment_statistics/engage.comment_statisticsReturns the comments the brand posted in the window, grouped by the kind of content they were posted on, together with the likes and replies those comments received. These are comments the brand wrote, not comments left on its content; comments.list returns the latter.
The five categories add up to total_comments_posted.
Parameters
brand_id Type: stringRequiredThe top-level brand to analyse, as returned by brands.list. A sub-brand is refused with the id of the parent to use instead.
brand_id Type: stringRequiredThe top-level brand to analyse, as returned by brands.list. A sub-brand is refused with the id of the parent to use instead.
platformType: enum[]unique items truePlatforms to include, comma-separated. Defaults to all of them.
Show values
platformType: enum[]unique items truePlatforms to include, comma-separated. Defaults to all of them.
- unique items
- true
instagramtiktokyoutubeposted_after Type: string(date-time)Start of the window (UTC, ISO 8601). Supplying more than one start is accepted and only one applies: this one wins over posted_within_hours, which wins over posted_within_days.
posted_after Type: string(date-time)Start of the window (UTC, ISO 8601). Supplying more than one start is accepted and only one applies: this one wins over posted_within_hours, which wins over posted_within_days.
posted_before Type: string(date-time)End of the window (UTC, ISO 8601). Defaults to the current time, and a relative start is counted back from it.
posted_before Type: string(date-time)End of the window (UTC, ISO 8601). Defaults to the current time, and a relative start is counted back from it.
posted_within_hours Type: integerminimum 1 · maximum 8760Start of the window, counted back from posted_before or the current time, in hours (1-8760). posted_after wins over it; it wins over posted_within_days.
posted_within_hours Type: integerminimum 1 · maximum 8760Start of the window, counted back from posted_before or the current time, in hours (1-8760). posted_after wins over it; it wins over posted_within_days.
- minimum
- 1
- maximum
- 8760
posted_within_days Type: integerminimum 1 · maximum 365Start of the window, counted back from posted_before or the current time, in days (1-365). Defaults to 7 when no date parameter is supplied, and loses to posted_after and posted_within_hours.
posted_within_days Type: integerminimum 1 · maximum 365Start of the window, counted back from posted_before or the current time, in days (1-365). Defaults to 7 when no date parameter is supplied, and loses to posted_after and posted_within_hours.
- minimum
- 1
- maximum
- 365
Returns CommentStatistics
total_comments_posted Type: integerComments the brand posted in the window, across every category.
total_comments_posted Type: integerComments the brand posted in the window, across every category.
categoriesType: CommentCategory[]One entry per category. They add up to total_comments_posted.
Show child attributes
categoriesType: CommentCategory[]One entry per category. They add up to total_comments_posted.
categories[].categoryType: stringbrand, owned, competitors, themes or other. other covers content outside the brand's own tree.
categories[].categoryType: stringbrand, owned, competitors, themes or other. other covers content outside the brand's own tree.
categories[].commentsType: integerComments posted on this category.
categories[].commentsType: integerComments posted on this category.
categories[].likesType: integerLikes those comments received.
categories[].likesType: integerLikes those comments received.
categories[].repliesType: integerReplies those comments received.
categories[].repliesType: integerReplies those comments received.
Responses
CommentStatistics
total_comments_posted Type: integerComments the brand posted in the window, across every category.
total_comments_posted Type: integerComments the brand posted in the window, across every category.
categoriesType: CommentCategory[]One entry per category. They add up to total_comments_posted.
Show child attributes
categoriesType: CommentCategory[]One entry per category. They add up to total_comments_posted.
categories[].categoryType: stringbrand, owned, competitors, themes or other. other covers content outside the brand's own tree.
categories[].categoryType: stringbrand, owned, competitors, themes or other. other covers content outside the brand's own tree.
categories[].commentsType: integerComments posted on this category.
categories[].commentsType: integerComments posted on this category.
categories[].likesType: integerLikes those comments received.
categories[].likesType: integerLikes those comments received.
categories[].repliesType: integerReplies those comments received.
categories[].repliesType: integerReplies those comments received.