The Community API lets you sync social media conversations with your customer service platform. This guide covers:Documentation Index
Fetch the complete documentation index at: https://developer.dashsocial.com/llms.txt
Use this file to discover all available pages before exploring further.
- Retrieving and replying to direct messages across Instagram, Facebook, and X
- Retrieving and replying to comments across Facebook, Instagram, TikTok, and YouTube
- Analyzing sentiment distribution and trends over time
API update: DMs have moved from conversation-level to message-level interactions.
GET /community_interactions now returns one result per message instead of per conversation. See the migration changelog for full details.Use cases
Customer service teams use the Community API to connect social conversations directly into their support workflows.Support Ticket Routing
Filter DMs by keyword to surface complaints and automatically route them to the right support queue in Zendesk or Salesforce.
Comment Moderation
Pull comments across Facebook and Instagram posts to review, tag, and respond without leaving your existing tooling.
Sentiment Monitoring
Track positive and negative sentiment trends over time to catch issues early and measure the impact of campaigns or product launches.
Before you start
Make sure you have:- API access token with permissions to the relevant brand.
- Brand ID for the account you want to query.
Use Case 1: Retrieve and Respond to Direct Messages
Filter DMs by platform, keyword, and date range to surface messages that need attention, then reply directly through the API.Step 1: Retrieve DMs
GET /community_interactions returns a list of individual messages. Each result is a single message with its content in text and a conversation_id linking it to the thread it belongs to.
See the Get Community Interactions endpoint reference for the full parameter list.
| Parameter | Description |
|---|---|
brand_id | Required. The brand to query. |
types | Filter by interaction type. Use , as OR for multiple types. DMs: INSTAGRAM_CONVERSATION, FACEBOOK_CONVERSATION, TWITTER_CONVERSATION, COMMUNITY_INTERACTION |
source_updated_after / source_updated_before | Date range filter. ISO 8601 format. Time is optional: 2024-08-15 and 2024-08-15T00:00:00-04:00 are both valid. |
message_nested_date_filter | Set to true to narrow results to threads where keyword matches fall within the date range. |
query | Keyword filter. Use , as OR for multiple keywords. |
sort | Sort order. -SOURCE_UPDATED_AT (most recently updated first), SOURCE_UPDATED_AT (oldest first), RELEVANCE, SAMPLE (random sample, only valid for COMMUNITY_INTERACTION type) |
is_closed | Set to false to exclude closed interactions. |
limit | Number of results to return. Maximum 100 to avoid rate limiting. |
offset | Pagination offset. |
INSTAGRAM_CONVERSATION includes story replies and story mentions, not just direct messages. Check the story_reply and story_mention fields in the full thread (Step 2) to distinguish them.Step 2: Get the Full Thread (optional)
If you need the full message history for a conversation, use theconversation_id from Step 1. This step is optional — message content is already available in text from Step 1.
See the Get Interaction Messages endpoint reference.
Step 3: Reply to a Conversation
Send a reply using theconversation_id from Step 1.
Use Case 2: Retrieve and Respond to Comments
Use the sameGET /community_interactions endpoint to retrieve comments across platforms, then reply to them directly through the API.
Step 1: Retrieve Comments
Filter bytypes to pull comments across platforms. Use the same parameters as Use Case 1. The only difference is the types values.
See the Get Community Interactions endpoint reference for the full parameter list.
| Type | Description |
|---|---|
FACEBOOK_COMMENT, INSTAGRAM_COMMENT, TIKTOK_COMMENT, TWITTER_RETWEET, YOUTUBE_COMMENT | Organic comments across platforms. |
FACEBOOK_ADS_COMMENT, INSTAGRAM_ADS_COMMENT | Comments on paid ad posts. |
id you’ll use to reply in Step 2, and platform-specific comment identifiers (e.g. facebook_comment_id) in the full comment detail.
Retrieve comments for a specific post
Retrieve comments for a specific post
If you need comments scoped to a single post, use the platform-specific comment endpoints with a Then fetch comments for that post:Replace
media_id. First get the post’s id from the Library API, then pass it as media_id.facebook_comments with instagram_comments, tweets, tiktok_comments, or youtube_comments for other platforms. See the endpoint references for Facebook comments, Instagram comments, TikTok comments, and YouTube comments.Step 2: Reply to Comments
Use thefacebook_comment_id (or platform equivalent) from Step 1 as parent_comment_id to thread the reply under the original comment.
facebook_comments with instagram_comments, tweets, tiktok_comments, or youtube_comments for other platforms.
Response example:
Use Case 3: Analyze Community Sentiment
Track interaction volume, sentiment, and top keywords across platforms. All endpoints support multiple brands in a single request.Sentiment Distribution
POST /sentiment_distribution_stats returns the positive, neutral, and negative breakdown for a brand’s interactions. Filter by date range, platform type, and other attributes.
See the Get Sentiment Distribution Stats endpoint reference.
| Parameter | Description |
|---|---|
brand_ids | Required. One or more brand IDs. Pass multiple to analyze across brands at once: [144, 145, 146]. |
source_updated_after / source_updated_before | Date range for the interactions. ISO 8601 format. |
types | Filter by interaction type. Same values as GET /community_interactions. |
is_positive / is_negative / is_neutral | Filter to interactions with a specific sentiment label. |
is_closed | Filter by closed status. |
query | Keyword filter. |
tag_ids | Filter by interaction tag IDs (AND condition). |
data object with sentiment counts broken down per platform.
Sentiment Time Series
POST /sentiment_time_series returns per-platform sentiment data over time. Use this to chart sentiment trends across a date range.
See the Get Sentiment Time Series endpoint reference.
| Parameter | Description |
|---|---|
brand_ids | Required. One or more brand IDs. Pass multiple to analyze across brands at once: [144, 145, 146]. |
source_updated_after / source_updated_before | Date range for the time series. ISO 8601 format. |
scale | Time series granularity: DAY, HOUR, WEEK, MONTH, QUARTER. |
types | Filter by interaction type. Same values as GET /community_interactions. |
is_closed | Filter by closed status. |
query | Keyword filter. |
tag_ids | Filter by interaction tag IDs (AND condition). |
data object with per-platform sentiment counts indexed by date.
Volume Time Series
POST /volume_time_series returns interaction volume over time, broken down by interaction type per date. Use this to track how many comments, messages, and mentions your brand receives across platforms.
DM messages are now included in volume calculations. If your brand has active DMs, expect higher counts compared to previous results.
See the Get Volume Time Series endpoint reference.
| Parameter | Description |
|---|---|
brand_ids | Required. One or more brand IDs. Pass multiple to analyze across brands at once: [144, 145, 146]. |
source_updated_after / source_updated_before | Date range filter. ISO 8601 format. Time is optional: 2024-08-15 and 2024-08-15T00:00:00-04:00 are both valid. |
scale | Time series granularity: DAY, HOUR, WEEK, MONTH, QUARTER. |
types | Filter by interaction type. Same values as GET /community_interactions. |
is_closed | Filter by closed status. |
query | Keyword filter. |
tag_ids | Filter by interaction tag IDs (AND condition). |
total as the sum across all types for that day.
Top Keywords
POST /top_keywords returns the most frequent keywords from community interactions, ranked by total mentions. Each keyword includes a sentiment breakdown so you can see whether mentions are positive, neutral, or negative.
See the Get Top Keywords endpoint reference.
| Parameter | Description |
|---|---|
brand_ids | Required. One or more brand IDs. Pass multiple to analyze across brands at once: [144, 145, 146]. |
source_updated_after / source_updated_before | Date range filter. ISO 8601 format. Time is optional: 2024-08-15 and 2024-08-15T00:00:00-04:00 are both valid. |
types | Filter by interaction type. Same values as GET /community_interactions. |
query | Keyword filter to scope results. |
is_closed | Filter by closed status. |
tag_ids | Filter by interaction tag IDs (AND condition). |
Limitations
- All channels: Group DMs are not supported.
- Instagram: Brands cannot reply to DMs received more than 7 days ago. Deleted comments are not reported back to Dash Social.
- Facebook: Brands cannot reply to DMs received more than 7 days ago. Deleted comments are not reported back to Dash Social.
- TikTok:
@mentionsin replies are rendered as plain text without linking to the mentioned profile. - X (Twitter): Deleted comments are not reported back to Dash Social.
- YouTube: Only root-level comments are imported. Replies to comments are not supported. Native emojis are not rendered when replying via the API.