> ## 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 resumo do CRM > Devolve os totais de cards e de valores (ganhos, perdidos e em andamento) e o tempo máximo e mínimo até o fechamento. ## OpenAPI ````yaml /api-reference/openapi.yaml get /crm/dashboard/resume 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: /crm/dashboard/resume: get: tags: - crm summary: Consultar resumo do CRM description: >- Devolve os totais de cards e de valores (ganhos, perdidos e em andamento) e o tempo máximo e mínimo até o fechamento. parameters: - name: boardId in: query description: >- Limita os indicadores a um painel. Sem o parâmetro, considera todos os painéis que você pode ver. schema: type: integer example: 7 - name: dateFrom in: query description: Início do período analisado. O dia começa no fuso da sua empresa. schema: type: string format: date example: '2026-09-01' - name: dateTo in: query description: >- Fim do período analisado. O dia termina às 23:59:59 no fuso da sua empresa. schema: type: string format: date example: '2026-09-30' - name: won in: query description: >- Filtra pela situação do card: `won` ganhos, `lost` perdidos, `inProgress` em andamento, `all` todos. schema: type: string enum: - all - won - lost - inProgress default: all responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CrmDashboardResume' components: schemas: CrmDashboardResume: type: object description: >- Resumo do funil nos filtros aplicados. Um card sem desfecho tem `won: null` e entra em `totalCardsInProgress`, sem contar como ganho nem como perdido. properties: totalCards: type: integer description: Quantidade de cards nos filtros aplicados. example: 320 totalCardsWon: type: integer description: Quantidade de cards ganhos. example: 96 totalCardsLost: type: integer description: Quantidade de cards perdidos. example: 74 totalCardsInProgress: type: integer description: Quantidade de cards ainda sem desfecho. example: 150 priceCards: type: number description: Valor somado de todos os cards. example: 412000 priceCardsWon: type: number description: Valor somado dos cards ganhos. example: 128400 priceCardsLost: type: number description: Valor somado dos cards perdidos. example: 96200 priceCardsInProgress: type: number description: Valor somado dos cards ainda sem desfecho. example: 187400 maxTimeToClose: type: number description: Maior tempo até o card ser ganho, em dias (com casas decimais). example: 41.2 minTimeToClose: type: number description: Menor tempo até o card ser ganho, em dias. example: 0.4 avgTimeToClose: type: number description: Tempo médio até o card ser ganho, em dias. example: 11.8 conversionTotalCards: type: number description: >- Taxa de conversão por quantidade de cards, calculada como `totalCardsWon / totalCards` e expressa em porcentagem (de 0 a 100). example: 30 conversionPriceCards: type: number description: >- Taxa de conversão por valor, calculada como `priceCardsWon / priceCards` e expressa em porcentagem. example: 31.16 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.