> ## 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 relatório de automações > Lista as execuções de automação em andamento. ## OpenAPI ````yaml /api-reference/openapi.yaml get /reports/automations 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/automations: get: tags: - reports summary: Consultar relatório de automações description: Lista as execuções de automação em andamento. parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/perPage' - name: fromDate in: query description: Início do período analisado. O dia começa no fuso da sua empresa. schema: type: string format: date-time example: '2026-09-01' - name: toDate 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-time example: '2026-09-30' - name: contact in: query description: Busca por nome ou número do contato. schema: type: string example: marina - name: automationIds in: query description: Ids das automações, separados por vírgula. schema: type: string example: 12,15 - name: triggers in: query description: Tipos de gatilho, separados por vírgula. schema: type: string example: message,keyword - name: statuses in: query description: Situações da conversa, separadas por vírgula. schema: type: string example: finished,abandoned - name: source in: query description: Origem da execução. schema: type: string default: automatic example: automatic responses: '200': description: OK content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/AutomationReportRow' meta: $ref: '#/components/schemas/PageMeta' components: parameters: page: name: page in: query description: Número da página, começando em 1. Um valor inválido é tratado como 1. schema: type: integer minimum: 1 default: 1 example: 1 perPage: name: perPage in: query description: >- Quantidade de itens por página. O máximo depende do ambiente (padrão 100). schema: type: integer minimum: 1 maximum: 100 default: 20 example: 50 schemas: AutomationReportRow: type: object description: >- Uma execução de automação do Flow. Os ids desta resposta vêm como texto (string), e não como número. properties: sessionId: type: string description: Identificador da execução. example: 9f2c1a70-31bd-4a4e-b0f2-17c6d3a91b55 automationId: type: string nullable: true description: Id interno da automação. publicAutomationId: type: string nullable: true description: Id público da automação, o mesmo que aparece no Flow. example: aut_7d21c9 automationName: type: string nullable: true example: Boas-vindas do site triggerType: type: string nullable: true description: O que disparou a execução. example: message_received triggerLabel: type: string nullable: true description: O mesmo gatilho, em texto pronto para exibir. example: Mensagem recebida startedAt: type: string format: date-time description: Início da execução. durationLabel: type: string description: >- Tempo decorrido desde o início, em texto, calculado no momento da consulta. example: 2 h 14 min executionStatus: type: string description: Estado da execução como registrado no Flow, sem interpretação. example: running contactId: type: string nullable: true description: Id do contato da execução, como string. example: '842' contactName: type: string nullable: true example: Maria Silva contactNumber: type: string nullable: true example: '5511987654321' ticketId: type: string nullable: true description: Id do atendimento associado, quando houver. protocolId: type: string nullable: true description: Protocolo associado. conversationStatus: type: string nullable: true description: >- Situação da conversa ligada à execução. Vem `null` quando o protocolo já foi encerrado. blockId: type: string nullable: true description: Bloco do fluxo em que a execução está parada. blockLabel: type: string nullable: true description: Nome desse bloco no editor do Flow. example: Aguarda resposta situation: type: string nullable: true description: >- Situação da execução já interpretada. Use este campo para mostrar o estado da execução a uma pessoa. example: Aguardando resposta do contato waitingFor: type: string nullable: true description: O que a execução está esperando para continuar. pausedBlockType: type: string nullable: true description: Tipo do bloco de entrada em que a execução parou. resumeAt: type: string format: date-time nullable: true description: Quando a execução continua sozinha, se houver um prazo definido. source: type: string nullable: true description: Origem do disparo. lastProgressAt: type: string format: date-time nullable: true description: Data do último avanço no fluxo. isOverdue: type: boolean nullable: true description: >- Indica se o prazo de `resumeAt` já passou sem que a execução tenha continuado. example: false PageMeta: type: object required: - page - perPage - hasMore properties: page: type: integer example: 1 perPage: type: integer example: 20 hasMore: type: boolean description: Indica se há mais registros além desta página. example: true example: page: 1 perPage: 20 hasMore: 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.