> ## 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.

# Get community overview stats

> Returns aggregated community overview header stats for the specified brands. Supports filtering by date range, platform, and interaction type.



## OpenAPI

````yaml api-reference/community-openapi.json GET /overview_stats
openapi: 3.0.2
info:
  contact:
    email: support@dashsocial.com
    name: Dash Social
    url: https://dashsocial.com
  description: Manage community interactions in the Dash Social platform.
  license:
    name: Commercial
    url: https://dashsocial.com/terms
  title: Community API
  version: 1.0.0
  x-logo:
    altText: Dash Social logo
    href: https://developer.dashsocial.com
    url: https://developer.dashsocial.com/assets/logo.svg
servers:
  - url: https://community.dashsocial.com
security:
  - BearerAuth: []
tags:
  - description: Endpoints responsible for comment sentiment.
    name: Comment Sentiment
  - description: Endpoints responsible for community interaction tags.
    name: Community Interaction Tags
  - description: Endpoints responsible for community interactions.
    name: Community Interactions
  - description: Endpoints responsible for community overview.
    name: Community Overview
  - description: Endpoints responsible for community post operations
    name: Community Posts
  - description: Endpoints responsible for managing Facebook comments.
    name: Facebook Comments
  - description: Endpoints responsible for managing Facebook messages.
    name: Facebook Messages
  - description: Endpoints responsible for managing Instagram comments.
    name: Instagram Comments
  - description: Endpoints responsible for Instagram messages.
    name: Instagram Messages
  - description: Endpoints responsible for community interaction automation rules.
    name: Interaction Rules
  - description: Endpoints responsible for managing preset replies.
    name: Preset replies
  - description: Endpoints responsible for managing TikTok comments.
    name: TikTok Comments
  - description: Endpoints responsible for managing Twitter messages.
    name: Twitter Messages
  - description: Endpoints responsible for managing Twitter tweets.
    name: Twitter Tweets
  - description: Endpoints responsible for managing YouTube Comments
    name: YouTube Comments
paths:
  /overview_stats:
    get:
      tags:
        - Community Overview V2
      summary: Get community overview stats
      description: >-
        Returns aggregated community overview header stats for the specified
        brands. Supports filtering by date range, platform, and interaction
        type.
      parameters:
        - description: List of brand_ids to fetch overview stats for
          explode: false
          in: query
          name: brand_ids
          required: true
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Comma separated list of types.
          explode: false
          in: query
          name: types
          required: false
          schema:
            items:
              enum:
                - FACEBOOK_ADS_COMMENT
                - FACEBOOK_COMMENT
                - FACEBOOK_CONVERSATION
                - INSTAGRAM_ADS_COMMENT
                - INSTAGRAM_COMMENT
                - INSTAGRAM_CONVERSATION
                - TIKTOK_CAPTION_MENTION
                - TIKTOK_COMMENT
                - TIKTOK_COMMENT_MENTION
                - TWITTER_CONVERSATION
                - TWITTER_MENTION
                - TWITTER_QUOTE
                - TWITTER_RETWEET
                - YOUTUBE_COMMENT
              type: string
            type: array
          style: form
        - description: >-
            Comma separated list of tag IDs to filter results by. Condition is
            AND
          explode: false
          in: query
          name: tag_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: >-
            When the community interaction was updated according to the source
            platform.
          in: query
          name: source_updated_after
          required: false
          schema:
            format: date-time
            type: string
        - description: >-
            When the community interaction was updated according to the source
            platform.
          in: query
          name: source_updated_before
          required: false
          schema:
            format: date-time
            type: string
        - description: Whether the community interaction is marked as archived.
          in: query
          name: is_archived
          required: false
          schema:
            type: boolean
        - description: Whether the community interaction is marked as follow-up.
          in: query
          name: is_follow_up
          required: false
          schema:
            type: boolean
        - description: A text that helps search for relevant records.
          in: query
          name: query
          required: false
          schema:
            type: string
        - description: Flag to determine if query is a list of comma separated keywords.
          in: query
          name: multiple_keywords
          required: false
          schema:
            type: boolean
        - description: Comma separated list of library media IDs
          explode: false
          in: query
          name: media_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: Is the comment is labeled as positive.
          in: query
          name: is_positive
          required: false
          schema:
            type: boolean
        - description: Is the comment is labeled as positive.
          in: query
          name: is_neutral
          required: false
          schema:
            type: boolean
        - description: Is the comment is labeled as positive.
          in: query
          name: is_negative
          required: false
          schema:
            type: boolean
        - description: Is the comment a question.
          in: query
          name: is_question
          required: false
          schema:
            type: boolean
        - description: Is the comment spam.
          in: query
          name: is_spam
          required: false
          schema:
            type: boolean
        - description: A ticket ID to filter results by with OR condition.
          in: query
          name: ticket_id
          required: false
          schema:
            type: string
        - description: ID of the assigned user
          in: query
          name: assignee_id
          required: false
          schema:
            type: integer
        - description: Comma separated list of assignee user IDs to filter by
          explode: false
          in: query
          name: assignee_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: The interaction rule by which to filter stats
          in: query
          name: interaction_rule_id
          required: false
          schema:
            type: integer
        - description: Determine if a response is recommended for the interaction.
          in: query
          name: response_recommended
          required: false
          schema:
            type: boolean
        - description: >-
            A map of field names, from this schema (and parent schemas), that
            operators types are provided for.
          in: query
          name: operators
          required: false
          schema:
            additionalProperties:
              type: string
            type: object
        - description: Filter by interactions that were deleted by user or rule
          in: query
          name: deleted_by
          required: false
          schema:
            enum:
              - RULE
              - USER
            type: string
        - description: Message content type to filter by
          explode: false
          in: query
          name: message_content
          required: false
          schema:
            items:
              enum:
                - EMOJI_ONLY
                - GIF_ONLY
                - HASHTAG_ONLY
                - LINK_ONLY
                - MENTION_ONLY
                - ONE_WORD_ONLY
                - UNSUPPORTED
              type: string
            type: array
          style: form
        - description: Subtypes to filter by
          explode: false
          in: query
          name: subtype
          required: false
          schema:
            items:
              enum:
                - POST_SHARE
                - REEL_SHARE
                - STORY_MENTION
                - STORY_REPLY
              type: string
            type: array
          style: form
        - description: Comma separated list of AI category IDs to filter by
          explode: false
          in: query
          name: ai_category_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
        - description: The interaction rules by which to filter stats
          explode: false
          in: query
          name: interaction_rule_ids
          required: false
          schema:
            items:
              type: integer
            type: array
          style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommunityOverviewStatsResponse'
          description: OK
        '422':
          $ref: '#/components/responses/UNPROCESSABLE_ENTITY'
        default:
          $ref: '#/components/responses/DEFAULT_ERROR'
components:
  schemas:
    CommunityOverviewStatsResponse:
      properties:
        data:
          allOf:
            - $ref: '#/components/schemas/CommunityOverviewStats'
          description: The sentiment distribution per platform
      required:
        - data
      type: object
    CommunityOverviewStats:
      properties:
        average_response_time:
          description: Average amount of time it took to respond to the interactions
          nullable: true
          type: number
        follow_up_count:
          description: Total number of community interactions marked as follow up
          type: integer
        new_message_count:
          description: Total number of unread community interactions
          type: integer
        reply_rate:
          description: Percentage of interactions that are considered responded to
          nullable: true
          type: number
        total_count:
          description: Total number of community interactions
          type: integer
      required:
        - average_response_time
        - follow_up_count
        - new_message_count
        - reply_rate
        - total_count
      type: object
    Error:
      properties:
        code:
          description: Error code
          type: integer
        errors:
          description: Errors
          type: object
        message:
          description: Error message
          type: string
        status:
          description: Error name
          type: string
      type: object
  responses:
    UNPROCESSABLE_ENTITY:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Unprocessable Entity
    DEFAULT_ERROR:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Default error response
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key from Dash Social developer settings

````