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

# Números da automação

> Execuções por estado e por passo, somando todas as versões pelo id do passo.



## OpenAPI

````yaml GET /v1/clubs/{clubId}/workflows/{workflowId}/stats
openapi: 3.0.3
info:
  title: weve API
  description: >
    Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de
    verdade**:

    os tipos e a interface de servidor em Go, e o client TypeScript, são todos

    gerados daqui (`make openapi`). Handler que divergir da interface não
    compila.


    A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de

    máquina, protegido por segredo dedicado, e não é contrato de cliente.
  version: 0.2.0
servers:
  - url: https://api.weve.cx
    description: produção
  - url: http://localhost:8080
    description: desenvolvimento
security: []
tags:
  - name: health
  - name: session
  - name: account
  - name: clubs
  - name: members
  - name: webhooks
  - name: outgoing-webhooks
  - name: sales-platforms
  - name: catalog
  - name: content
  - name: classroom
  - name: community
  - name: mentorships
  - name: agents
  - name: lives
  - name: students
  - name: auth
  - name: campaigns
  - name: workflows
  - name: email
paths:
  /v1/clubs/{clubId}/workflows/{workflowId}/stats:
    parameters:
      - $ref: '#/components/parameters/OrgId'
      - $ref: '#/components/parameters/WorkflowId'
    get:
      tags:
        - workflows
      summary: Os números da automação, por estado e por passo
      description: |
        Execuções por estado, e por passo: quantas passaram, quantas estão
        paradas nele, para que lado a condição mandou, e o que o e-mail do passo
        rendeu. Somam todas as versões pelo id do passo.
      operationId: getWorkflowStats
      responses:
        '200':
          description: Os números
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowStatsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - userSession: []
components:
  parameters:
    OrgId:
      name: clubId
      in: path
      required: true
      description: >
        Id público da organização — o mesmo que `GET /v1/me` devolve em

        `organization_id`.


        Na URL o recurso se chama **club**; no contrato e no domínio,
        organization.

        A divergência é deliberada: `clubs` é a palavra do produto, e a URL é o
        que

        as pessoas leem.


        É o identificador do provedor de autenticação, e é assim de propósito:

        o cliente precisa nomear a organização ao pedir o token, e o token é o

        que prova o escopo. Um id só nosso obrigaria a traduzir um no outro

        antes de ter um token — e a tradução exigiria uma chamada escopada, que

        é justamente a que ainda não dá para fazer.


        O uuid interno da organização não aparece no contrato: ele é o que as

        chaves estrangeiras do domínio referenciam, e continua sendo nosso.
      schema:
        type: string
        format: uuid
    WorkflowId:
      name: workflowId
      in: path
      required: true
      schema:
        type: string
        format: uuid
  schemas:
    WorkflowStatsResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/WorkflowStats'
    WorkflowStats:
      type: object
      required:
        - runs
        - steps
      properties:
        runs:
          $ref: '#/components/schemas/WorkflowRunCounts'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowStepStats'
    ErrorEnvelope:
      type: object
      description: >-
        Envelope único de erro da API. O `code` é o contrato com o cliente — a
        `message` é diagnóstico, e pode mudar.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
          properties:
            code:
              type: string
            message:
              type: string
    WorkflowRunCounts:
      type: object
      required:
        - total
        - waiting
        - running
        - completed
        - exited
        - canceled
        - failed
      properties:
        total:
          type: integer
        waiting:
          type: integer
        running:
          type: integer
        completed:
          type: integer
        exited:
          type: integer
        canceled:
          type: integer
        failed:
          type: integer
    WorkflowStepStats:
      type: object
      required:
        - step_id
        - kind
        - reached
        - waiting
        - 'yes'
        - 'no'
        - sent
        - skipped
        - failed
        - delivered
        - bounced
        - opened
        - clicked
      properties:
        step_id:
          type: string
        kind:
          type: string
          enum:
            - send_email
            - wait
            - condition
            - exit
        reached:
          type: integer
          description: Execuções que CONCLUÍRAM o passo.
        waiting:
          type: integer
          description: Execuções paradas nele agora.
        'yes':
          type: integer
        'no':
          type: integer
        sent:
          type: integer
        skipped:
          type: integer
        failed:
          type: integer
        delivered:
          type: integer
        bounced:
          type: integer
        opened:
          type: integer
        clicked:
          type: integer
  responses:
    Unauthorized:
      description: Sessão ausente, expirada ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: >
        A sessão é válida, mas não age nesta organização. É a mesma resposta
        para

        uma organização que não existe — distinguir as duas deixaria enumerar

        organizações alheias.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    NotFound:
      description: Recurso não encontrado
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    InternalError:
      description: >-
        Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no
        rastreamento.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    userSession:
      type: http
      scheme: bearer
      description: |
        Token OPACO de sessão de quem administra, emitido por
        `/v1/auth/admin/sign-in` e verificado contra a nossa tabela — o mesmo
        desenho do `studentSession`, para a outra identidade.

        É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
        `studentSession`; uma rota consumida pelos dois declara os dois
        esquemas, e o middleware aceita qualquer um deles. As duas credenciais
        são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
        que cada uma existe.

        O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
        `Authorization` a cada chamada.

````

## Related topics

- [Automação](/api-reference/workflows/get.md)
- [Arquivar automação](/api-reference/workflows/archive.md)
- [Criar automação](/api-reference/workflows/create.md)
- [Pausar automação](/api-reference/workflows/pause.md)
- [Alterar automação](/api-reference/workflows/update.md)
