> ## 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 indicadores consolidados > Aceita os mesmos filtros da tela de dashboard. ## OpenAPI ````yaml /api-reference/openapi.yaml get /reports/dashboard 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: get: tags: - reports summary: Consultar indicadores consolidados description: Aceita os mesmos filtros da tela de dashboard. responses: '200': description: OK content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ReportDashboard' components: schemas: ReportDashboard: type: object description: >- Relatório de atendimentos do período, com os contadores da empresa e uma linha por atendente. properties: counters: type: object description: Contadores de todo o conjunto filtrado. properties: avgSupportTime: type: number nullable: true description: Tempo médio de atendimento, em minutos. example: 12.4 avgWaitTime: type: number nullable: true description: Tempo médio de espera na fila, em minutos. example: 3.1 supportHappening: type: integer description: >- Atendimentos `open` neste momento. Este número ignora o filtro de período. example: 18 supportPending: type: integer description: Atendimentos `pending` neste momento. example: 5 supportFinished: type: integer description: Atendimentos encerrados no período. example: 640 leads: type: integer description: >- Contatos com exatamente um atendimento no período, ou seja, os que apareceram pela primeira vez. example: 212 attendants: type: array description: >- Uma linha por atendente da empresa, incluindo quem não atendeu no período (com valores zerados). items: $ref: '#/components/schemas/ReportDashboardAttendant' ReportDashboardAttendant: type: object description: Uma linha do relatório de atendimentos, com os números de um atendente. 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 avgSupportTime: type: number description: Tempo médio de atendimento, em minutos. example: 12.4 tickets: type: integer description: Atendimentos do atendente nos filtros aplicados. example: 84 rating: type: number description: >- Nota média das avaliações do atendente. `0` quando ele não foi avaliado. example: 4.6 online: type: boolean description: Indica se o atendente está conectado ao painel neste momento. example: true 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.