> ## Documentation Index
> Fetch the complete documentation index at: https://docs.airys.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter outgoing mensagens count grouped by entity

> Obter a contagem de mensagens enviadas agrupadas por uma entidade especificada (agente, equipe, caixa de entrada ou rótulo).
Quando agrupadas por agente, as mensagens enviadas por bots (AgentBot, Captain::Assistant) são excluídas.

**Observação:** Este endpoint de API está disponível apenas na versão 4.11.0 do Chatwoot e superior.




## OpenAPI

````yaml /pt-br/swagger/tag_groups/application_swagger.json get /api/v2/accounts/{account_id}/reports/outgoing_messages_count
openapi: 3.1.0
info:
  title: Chatwoot
  description: Esta é a documentação da API para o servidor Chatwoot.
  version: 1.1.0
  termsOfService: https://www.chatwoot.com/terms-of-service/
  contact:
    email: hello@chatwoot.com
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://airys.chat/
security: []
tags:
  - name: AgentBots de Conta
    description: Agent Bots específicos da conta
  - name: Agentes
    description: APIs de gerenciamento de agentes
  - name: Respostas Prontas
    description: Respostas predefinidas para consultas comuns
  - name: Contatos
    description: APIs de gerenciamento de contatos
  - name: Rótulos de Contato
    description: Gerenciar rótulos de contato
  - name: Atribuições de Conversa
    description: Gerenciar atribuições de conversas
  - name: Rótulos de Conversa
    description: Gerenciar rótulos de conversas
  - name: Conversas
    description: APIs de gerenciamento de conversas
  - name: Atributos Personalizados
    description: Campos personalizados para contatos e conversas
  - name: Filtros Personalizados
    description: Filtros salvos para conversas
  - name: Caixas de Entrada
    description: Configuração de canais de comunicação
  - name: Integrações
    description: Integrações de terceiros
  - name: Rótulos
    description: APIs de gerenciamento de rótulos da conta
  - name: Mensagens
    description: APIs de gerenciamento de mensagens
  - name: Perfil
    description: APIs de perfil de usuário
  - name: Relatórios
    description: APIs de análise e relatórios
  - name: Equipes
    description: APIs de gerenciamento de equipe
  - name: Webhooks
    description: Webhooks de notificação de eventos
  - name: Regra de Automação
    description: Regras de automação de fluxo de trabalho
  - name: Central de Ajuda
    description: Gerenciamento da base de conhecimento
paths:
  /api/v2/accounts/{account_id}/reports/outgoing_messages_count:
    parameters:
      - $ref: '#/components/parameters/account_id'
      - in: query
        name: since
        schema:
          type: string
        description: O timestamp de onde o relatório deve começar (Timestamp Unix).
      - in: query
        name: until
        schema:
          type: string
        description: O timestamp de onde o relatório deve parar (Timestamp Unix).
    get:
      tags:
        - Relatórios
      summary: Obter outgoing mensagens count grouped by entity
      description: >
        Obter a contagem de mensagens enviadas agrupadas por uma entidade
        especificada (agente, equipe, caixa de entrada ou rótulo).

        Quando agrupadas por agente, as mensagens enviadas por bots (AgentBot,
        Captain::Assistant) são excluídas.


        **Observação:** Este endpoint de API está disponível apenas na versão
        4.11.0 do Chatwoot e superior.
      operationId: get-outgoing-messages-count
      parameters:
        - in: query
          name: group_by
          required: true
          schema:
            type: string
            enum:
              - agent
              - team
              - inbox
              - label
          description: A entidade para agrupar as contagens de mensagens enviadas.
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/outgoing_messages_count'
        '403':
          description: Acesso negado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad_request_error'
      security:
        - userApiKey: []
components:
  parameters:
    account_id:
      in: path
      name: account_id
      schema:
        type: integer
      required: true
      description: O ID numérico da conta
  schemas:
    outgoing_messages_count:
      type: array
      description: >-
        Relatório de contagem de mensagens enviadas agrupado por entidade
        (agente, equipe, caixa de entrada ou rótulo).
      items:
        type: object
        properties:
          id:
            type: number
            description: >-
              O ID da entidade agrupada (agente, equipe, caixa de entrada ou
              rótulo).
          name:
            type: string
            description: O nome da entidade agrupada.
          outgoing_messages_count:
            type: number
            description: >-
              O número total de mensagens enviadas para esta entidade no
              intervalo de tempo determinado.
      example:
        - id: 1
          name: Agent One
          outgoing_messages_count: 42
        - id: 2
          name: Agent Two
          outgoing_messages_count: 18
    bad_request_error:
      title: data
      type: object
      properties:
        description:
          type: string
        errors:
          type: array
          items:
            $ref: '#/components/schemas/request_error'
    request_error:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        code:
          type: string
  securitySchemes:
    userApiKey:
      type: apiKey
      in: header
      name: api_access_token
      description: >-
        Este token pode ser obtido visitando a página de perfil ou por meio do
        console rails. Fornece acesso a endpoints com base nos níveis de
        permissões do usuário. Este token pode ser salvo por um sistema externo
        quando o usuário é criado via API, para realizar atividades em nome do
        usuário.

````