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

# Consultar situação em tempo real

> Mostra os atendimentos abertos e aguardando e os atendentes disponíveis neste momento.



## OpenAPI

````yaml /api-reference/openapi.yaml get /reports/dashboard/now
openapi: 3.0.3
info:
  title: Connecta DESK API pública
  version: 1.0.0
  description: >
    API pública do Connecta DESK, disponível em `/api/v1`. O acesso é feito com
    um token gerado no módulo de tokens. Cada token tem permissões por **módulo
    × método**, e toda leitura de lista é paginada.


    ## Autenticação


    ```

    Authorization: Bearer sk_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

    ```


    O token pertence a uma **empresa**, e não a um usuário. A empresa usada é
    sempre a do token, então enviar `companyId` no corpo não tem efeito. Token
    ausente, inválido, revogado ou expirado recebe a mesma resposta `401`.


    ## Ordem de verificação


    1. **token** → `401`

    2. **empresa ativa** → `403`

    3. **API habilitada no plano** → `403 ERR_API_NOT_ENABLED` (não se aplica a
    on-premise)

    4. **rate limit da empresa** → `429`

    5. **permissão do token** → `403 ERR_API_FORBIDDEN_SCOPE`


    ## Ids de usuário


    Todo id de usuário na API é o id do usuário **nesta empresa**, o mesmo que
    `GET /users` devolve. Vale para o que a API responde (`user.id`,
    `assignedTo.id`, `userCreated.id`) e para o que ela aceita (`userId`,
    `userIds`, `assignedToUserId` e o `{id}` das rotas de usuário).


    A mesma pessoa pode trabalhar em várias empresas, com nome e perfil
    diferentes em cada uma, e tem um id diferente em cada empresa.


    Um id que não pertence a esta empresa responde `404`, com a mesma mensagem
    de um id inexistente.


    ## Paginação


    Todo `GET` de lista é paginado. O `meta` traz apenas `page`, `perPage` e
    `hasMore`, sem o total de registros. Para percorrer tudo, avance `page`
    enquanto `hasMore` for `true`.


    ## Idempotência


    Opcional em `POST`/`PUT`, pelo header `Idempotency-Key`. Se você repetir a
    chamada com a mesma chave e o mesmo corpo, recebe a resposta já gravada (com
    `Idempotent-Replay: true`). Com a mesma chave e um corpo diferente, a
    resposta é `409`.
servers:
  - url: https://api.connectadesk.com/api/v1
    description: Produção
security:
  - apiToken: []
tags:
  - name: contacts
    description: Cadastro de contatos, campos extras e origem de marketing.
  - name: tickets
    x-displayName: Conversas
    description: Abertura, transferência, encerramento e qualificação de conversas.
  - name: messages
    description: Envio assíncrono e leitura de mensagens.
  - name: tags
    description: Tags e vínculo com atendimentos.
  - name: queues
    description: Filas de atendimento e seus atendentes.
  - name: wrapups
    description: Tipos de qualificação.
  - name: users
    description: Atendentes e administradores.
  - name: schedules
    description: Mensagens programadas.
  - name: quick-messages
    description: Respostas rápidas.
  - name: campaigns
    description: Disparos em massa.
  - name: crm
    description: Painéis, etapas, cards e indicadores.
  - name: channels
    description: Canais (somente leitura).
  - name: reports
    description: Relatórios e dashboards.
  - name: products
    description: Catálogo de produtos, categorias e desempenho nas vendas.
  - name: custom-fields
    description: >-
      Campos personalizados de contato e de card, e variáveis globais da
      empresa.
  - name: profiles
    description: Perfis de permissões da empresa (somente leitura).
  - name: webchat
    description: >-
      Webchat nativo pelo seu sistema: abrir sessão de um visitante, enviar e
      ler mensagens. O token precisa do escopo `webchat` (GET e POST).
paths:
  /reports/dashboard/now:
    get:
      tags:
        - reports
      summary: Consultar situação em tempo real
      description: >-
        Mostra os atendimentos abertos e aguardando e os atendentes disponíveis
        neste momento.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ReportDashboardNow'
components:
  schemas:
    ReportDashboardNow:
      type: object
      description: >-
        Retrato do atendimento neste momento. Cada seção é uma lista de linhas
        agregadas. Os dados podem ter até 150 segundos de atraso, então duas
        consultas seguidas podem trazer os mesmos números.
      properties:
        allInfo:
          type: array
          description: Contadores gerais da empresa. Uma única linha.
          items:
            type: object
            properties:
              total:
                type: integer
                description: Atendimentos nos filtros aplicados.
                example: 940
              unique_contacts:
                type: integer
                description: Contatos que apareceram pela primeira vez hoje.
                example: 74
              total_chat_waiting:
                type: integer
                description: Atendimentos aguardando atendente, fora do chatbot.
                example: 5
              total_chat_in_service:
                type: integer
                description: Atendimentos com um atendente humano.
                example: 18
              total_chat_bot:
                type: integer
                description: Atendimentos em fluxo de chatbot.
                example: 12
              total_nps:
                type: integer
                description: Atendimentos em pesquisa de satisfação.
                example: 3
              total_chat_finished:
                type: integer
                description: Atendimentos encerrados.
                example: 902
              total_outcoming:
                type: integer
                description: Atendimentos iniciados pela empresa hoje.
                example: 140
              total_incoming:
                type: integer
                description: Atendimentos iniciados pelo contato hoje.
                example: 380
              total_chat_bot_wrapuped:
                type: integer
                description: >-
                  Atendimentos encerrados e qualificados pelo próprio chatbot,
                  sem passar por um atendente.
                example: 66
              time_average_first_answer_seconds:
                type: number
                nullable: true
                description: Tempo médio até a primeira resposta, em segundos.
                example: 92.4
              time_average_human_service_seconds:
                type: number
                nullable: true
                description: Tempo médio de atendimento humano, em segundos.
                example: 744
              time_average_chatbot_service_seconds:
                type: number
                nullable: true
                description: Tempo médio de permanência no chatbot, em segundos.
                example: 130.5
        usersInfo:
          type: array
          description: Uma linha por atendente da empresa.
          items:
            type: object
            properties:
              id:
                type: integer
                description: Id do usuário nesta empresa, o mesmo que `GET /users` devolve.
                example: 3
              name:
                type: string
                example: Marina Alves
              profile:
                type: string
                nullable: true
                description: Nome do perfil nesta empresa (`Owner` para o proprietário).
                example: Atendente
              online:
                type: boolean
                example: true
              chats:
                type: integer
                description: Atendimentos do atendente nos filtros aplicados.
                example: 24
              count_chats_open:
                type: integer
                description: Atendimentos em aberto com o atendente neste momento.
                example: 4
              count_chats_finished:
                type: integer
                description: Atendimentos encerrados por este atendente.
                example: 20
              time_average_service_seconds:
                type: number
                nullable: true
                description: Tempo médio de atendimento deste atendente, em segundos.
                example: 690
        openChatsInfo:
          type: array
          description: >-
            Atendimentos encerrados, agrupados em faixas de 5 minutos. São os
            dados do gráfico de movimento do dia.
          items:
            type: object
            properties:
              total:
                type: integer
                description: Quantidade de atendimentos na faixa.
                example: 7
              time_group:
                type: string
                format: date-time
                description: Início da faixa de 5 minutos.
                example: '2026-09-09T14:35:00.000Z'
        usersOnlineCount:
          type: array
          description: Quantos atendentes estão conectados agora. Vem em uma única linha.
          items:
            type: object
            properties:
              count:
                type: integer
                example: 11
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      description: Token da API no formato `sk_live_…`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.