> ## 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 inbox-label matrix report

> Obter uma matriz mostrando a contagem de conversas para cada combinação de caixa de entrada e rótulo.
Retorna uma lista de caixas de entrada, rótulos e uma matriz 2D onde cada célula contém a contagem de conversas
em uma caixa de entrada específica que têm um rótulo específico aplicado.

**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/inbox_label_matrix
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/inbox_label_matrix:
    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).
      - in: query
        name: inbox_ids
        schema:
          type: array
          items:
            type: integer
        description: Filtrar por IDs de caixas de entrada específicos.
      - in: query
        name: label_ids
        schema:
          type: array
          items:
            type: integer
        description: Filtrar por IDs de rótulos específicos.
    get:
      tags:
        - Relatórios
      summary: Obter inbox-label matrix report
      description: >
        Obter uma matriz mostrando a contagem de conversas para cada combinação
        de caixa de entrada e rótulo.

        Retorna uma lista de caixas de entrada, rótulos e uma matriz 2D onde
        cada célula contém a contagem de conversas

        em uma caixa de entrada específica que têm um rótulo específico
        aplicado.


        **Observação:** Este endpoint de API está disponível apenas na versão
        4.11.0 do Chatwoot e superior.
      operationId: get-inbox-label-matrix
      responses:
        '200':
          description: Sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inbox_label_matrix'
        '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:
    inbox_label_matrix:
      type: object
      description: >-
        Relatório de matriz de caixa de entrada-rótulo mostrando a contagem de
        conversas para cada combinação de caixa de entrada-rótulo.
      properties:
        inboxes:
          type: array
          description: Lista de caixas de entrada incluídas no relatório
          items:
            type: object
            properties:
              id:
                type: number
                description: O ID da caixa de entrada
              name:
                type: string
                description: O nome da caixa de entrada
        labels:
          type: array
          description: Lista de rótulos incluídos no relatório
          items:
            type: object
            properties:
              id:
                type: number
                description: O ID do rótulo
              title:
                type: string
                description: O título do rótulo
        matrix:
          type: array
          description: >-
            Matriz 2D onde matriz[i][j] representa a contagem de conversas em
            inboxes[i] com labels[j]
          items:
            type: array
            items:
              type: number
      example:
        inboxes:
          - id: 1
            name: Website Chat
          - id: 2
            name: Email Support
        labels:
          - id: 1
            title: bug
          - id: 2
            title: feature-request
          - id: 3
            title: urgent
        matrix:
          - - 10
            - 5
            - 3
          - - 8
            - 12
            - 2
    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.

````