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

# Métricas do funil

> Obtém métricas detalhadas de um funil de projetos, incluindo distribuição por etapa, tempo médio, atividade e contadores.

Suporta filtro por período (padrão: últimos 30 dias, máximo: 3 meses).

Requer permissão `project_funnels.see_funnel_metrics` e acesso de visualização ao funil (`project_funnels.view.{funnel_id}` ou `project_funnels.view_all`).



## OpenAPI

````yaml /api-reference/openapi.json get /api/management/project-funnels/{project_funnel_id}/metrics
openapi: 3.0.0
info:
  title: Olie API
  version: 1.0.0
  description: >
    # Introdução 👋


    Olá! Esta é a documentação oficial da API da [olie.ai](https://olie.ai/).
    Aqui você encontra as referências e exemplos de uso dos nossos endpoints.


    Para uma visão completa, recomendamos fortemente que você leia a
    [documentação oficial](https://docs.olie.ai/api-reference/introduction). Lá
    estão detalhados tópicos essenciais como
    [autenticação](https://docs.olie.ai/api-reference/introduction/authentication),
    [estrutura de
    respostas](https://docs.olie.ai/api-reference/general/response-structure),
    [paginação](https://docs.olie.ai/api-reference/general/pagination) e outros
    guias de integração.


    No Postman, esta coleção foca nas informações específicas de cada requisição
    (endpoints, parâmetros e exemplos), servindo como apoio rápido para testes e
    desenvolvimento.
servers:
  - url: https://api.olie.ai
security:
  - BearerAuth: []
paths:
  /api/management/project-funnels/{project_funnel_id}/metrics:
    parameters:
      - name: project_funnel_id
        in: path
        required: true
        description: ID do funil de projeto
        deprecated: false
        schema:
          type: integer
        example: 8017
    get:
      tags:
        - project-funnels
        - '{project_funnel_id}'
      summary: Métricas do funil
      description: >-
        Obtém métricas detalhadas de um funil de projetos, incluindo
        distribuição por etapa, tempo médio, atividade e contadores.


        Suporta filtro por período (padrão: últimos 30 dias, máximo: 3 meses).


        Requer permissão `project_funnels.see_funnel_metrics` e acesso de
        visualização ao funil (`project_funnels.view.{funnel_id}` ou
        `project_funnels.view_all`).
      parameters:
        - name: start_date
          in: query
          description: Data de início do período. Opcional
          schema:
            type: string
            format: date
          example: '2019-03-07'
        - name: end_date
          in: query
          description: >-
            Data de fim do período. Obrigatório quando o start_date for
            informado.
          schema:
            type: string
          example: string
      responses:
        '200':
          description: Sucesso
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
              example: '*'
            Access-Control-Expose-Headers:
              schema:
                type: string
              example: '*'
            Cache-Control:
              schema:
                type: string
              example: no-cache, private
            Content-Encoding:
              schema:
                type: string
              example: gzip
            Date:
              schema:
                type: string
              example: Mon, 09 Feb 2026 02:49:22 GMT
            Referrer-Policy:
              schema:
                type: string
              example: strict-origin-when-cross-origin
            Server:
              schema:
                type: string
              example: nginx
            Strict-Transport-Security:
              schema:
                type: string
              example: max-age=31536000; includeSubDomains
            Vary:
              schema:
                type: string
              example: Accept-Encoding
            X-Content-Type-Options:
              schema:
                type: string
              example: nosniff
            X-Frame-Options:
              schema:
                type: string
              example: SAMEORIGIN
            X-Ratelimit-Limit:
              schema:
                type: integer
              example: 160
            X-Ratelimit-Remaining:
              schema:
                type: integer
              example: 157
            Transfer-Encoding:
              schema:
                type: string
              example: chunked
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: boolean
                    description: Indica se a requisição foi bem-sucedida
                  metrics:
                    type: object
                    properties:
                      period:
                        type: object
                        properties:
                          start_date:
                            type: string
                            description: 'Data inicial do período analisado (formato: Y-m-d)'
                            format: date
                          end_date:
                            type: string
                            description: 'Data final do período analisado (formato: Y-m-d)'
                            format: date
                          is_default:
                            type: boolean
                            description: Indica se o período é o padrão ou foi customizado
                        required:
                          - start_date
                          - end_date
                          - is_default
                      basic:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: ID do funil
                          name:
                            type: string
                            description: Nome do funil
                          condition:
                            type: string
                            enum:
                              - active
                              - inactive
                            description: Condição do funil (ativo ou inativo)
                          steps:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  description: ID da etapa
                                name:
                                  type: string
                                  description: Nome da etapa
                                form_id:
                                  type: integer
                                  description: >-
                                    ID do formulário associado à etapa (null se
                                    não houver)
                              required:
                                - id
                                - name
                          funnel_form:
                            type: object
                            description: Formulário associado ao funil (null se não houver)
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                          business_area:
                            type: object
                            description: >-
                              Área de negócio associada ao funil (null se não
                              houver)
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                          created_at:
                            type: string
                            description: Data de criação do funil (ISO 8601)
                            format: date-time
                          updated_at:
                            type: string
                            description: Data de última atualização do funil (ISO 8601)
                            format: date-time
                        required:
                          - id
                          - name
                          - condition
                          - steps
                      counts:
                        type: object
                        properties:
                          total_steps:
                            type: integer
                            minimum: 0
                            description: Total de etapas no funil
                          total_projects:
                            type: integer
                            minimum: 0
                            description: Total de projetos vinculados ao funil
                          active_projects:
                            type: integer
                            minimum: 0
                            description: >-
                              Total de projetos no funil com status = em
                              andamento
                          tags_count:
                            type: integer
                            minimum: 0
                            description: Total de tags do funil
                          attachments_count:
                            type: integer
                            minimum: 0
                            description: Total de anexos do funil
                        required:
                          - total_steps
                          - total_projects
                          - active_projects
                          - tags_count
                          - attachments_count
                      steps_distribution:
                        type: array
                        description: >-
                          Distribuição de projetos por etapa, ordenada por
                          quantidade de projetos (maior para menor)
                        items:
                          type: object
                          properties:
                            step_id:
                              type: integer
                              description: ID da etapa
                            step_name:
                              type: string
                              description: Nome da etapa
                            projects_count:
                              type: integer
                              minimum: 0
                              description: Quantidade atual de projetos na etapa
                            projects_entry_in_period:
                              type: integer
                              minimum: 0
                              description: >-
                                Quantidade de projetos que entraram na etapa no
                                período analisado
                            projects_exit_in_period:
                              type: integer
                              minimum: 0
                              description: >-
                                Quantidade de projetos que saíram da etapa no
                                período analisado
                          required:
                            - step_id
                            - step_name
                            - projects_count
                            - projects_entry_in_period
                            - projects_exit_in_period
                      steps_summary:
                        type: object
                        properties:
                          most_occupied_step:
                            type: object
                            description: >-
                              Etapa com maior quantidade de projetos (null se
                              não houver projetos)
                            properties:
                              step_id:
                                type: integer
                              step_name:
                                type: string
                              step_form_id:
                                type: integer
                              projects_count:
                                type: integer
                                minimum: 0
                          empty_steps_ids:
                            type: array
                            description: Array com IDs das etapas que não possuem projetos
                            items:
                              type: integer
                          empty_steps_count:
                            type: integer
                            minimum: 0
                            description: Quantidade de etapas vazias
                        required:
                          - most_occupied_step
                          - empty_steps_ids
                          - empty_steps_count
                      time_metrics:
                        type: object
                        properties:
                          average_time_in_funnel_minutes:
                            type: number
                            minimum: 0
                            description: >-
                              Tempo médio (em minutos) que projetos ficam no
                              funil, baseado em transições completas no período
                          average_time_per_step_minutes:
                            type: array
                            description: Tempo médio por etapa
                            items:
                              type: object
                              properties:
                                step_id:
                                  type: integer
                                step_name:
                                  type: string
                                average_time_minutes:
                                  type: number
                                  minimum: 0
                                  description: >-
                                    Tempo médio (em minutos) que projetos ficam
                                    nesta etapa, baseado em transições completas
                                    no período
                              required:
                                - step_id
                                - step_name
                                - average_time_minutes
                          oldest_project_id:
                            type: string
                            description: >-
                              ID do projeto mais antigo vinculado ao funil (null
                              se não houver projetos)
                            format: uuid
                          newest_project_id:
                            type: string
                            description: >-
                              ID do projeto mais recente vinculado ao funil
                              (null se não houver projetos)
                            format: uuid
                          oldest_project_minutes:
                            type: number
                            minimum: 0
                            description: >-
                              Tempo em minutos desde a criação do projeto mais
                              antigo até agora
                          newest_project_minutes:
                            type: number
                            minimum: 0
                            description: >-
                              Tempo em minutos desde a criação do projeto mais
                              recente até agora
                        required:
                          - average_time_in_funnel_minutes
                          - average_time_per_step_minutes
                          - oldest_project_id
                          - newest_project_id
                          - oldest_project_minutes
                          - newest_project_minutes
                      activity:
                        type: object
                        properties:
                          last_activity_at:
                            type: string
                            description: >-
                              Data e hora da última atividade no funil
                              (transição de etapa) no período analisado (ISO
                              8601, null se não houver atividade)
                            format: date-time
                          projects_added_in_period:
                            type: integer
                            minimum: 0
                            description: >-
                              Quantidade de projetos adicionados ao funil no
                              período analisado
                        required:
                          - last_activity_at
                          - projects_added_in_period
                      tags:
                        type: array
                        description: Lista de tags do funil com contagem de projetos
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: ID da tag
                            name:
                              type: string
                              description: Nome da tag
                            color:
                              type: string
                              pattern: ^#[0-9A-Fa-f]{6}$
                              description: Cor da tag em formato hexadecimal (#RRGGBB)
                            projects_count:
                              type: integer
                              minimum: 0
                              description: Quantidade de projetos que possuem esta tag
                          required:
                            - id
                            - name
                            - color
                            - projects_count
                      funnel_status:
                        type: array
                        description: Lista de status do funil com contagem de projetos
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: ID do status
                            name:
                              type: string
                              description: Nome do status
                            color:
                              type: string
                              pattern: ^#[0-9A-Fa-f]{6}$
                              description: Cor do status em formato hexadecimal (#RRGGBB)
                            is_conclusive:
                              type: boolean
                              description: Indica se este é um status conclusivo
                            projects_count:
                              type: integer
                              minimum: 0
                              description: Quantidade de projetos com este status
                          required:
                            - id
                            - name
                            - color
                            - is_conclusive
                            - projects_count
                      attachments:
                        type: array
                        description: Lista de anexos do funil
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: ID do anexo
                            name:
                              type: string
                              description: Nome do anexo
                            technical_name:
                              type: string
                              description: Nome técnico do arquivo
                            extension:
                              type: string
                              description: Extensão do arquivo
                            file_url:
                              type: string
                              description: URL do arquivo
                              format: uri
                            user:
                              type: object
                              description: >-
                                Informações do usuário que fez upload do anexo
                                (null se não disponível)
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                name:
                                  type: string
                                avatar_url:
                                  type: string
                                  format: uri
                          required:
                            - id
                            - name
                            - technical_name
                            - extension
                            - file_url
                    required:
                      - period
                      - basic
                      - counts
                      - steps_distribution
                      - steps_summary
                      - time_metrics
                      - activity
                      - tags
                      - funnel_status
                      - attachments
                required:
                  - response
                  - metrics
              example:
                response: true
                metrics:
                  period:
                    start_date: '2026-01-09'
                    end_date: '2026-02-08'
                    is_default: true
                  basic:
                    id: 38
                    name: Marketing
                    condition: active
                    steps:
                      - id: 166
                        name: Backlog
                        form_id: null
                      - id: 167
                        name: Em Andamento
                        form_id: null
                      - id: 168
                        name: Correção
                        form_id: null
                      - id: 169
                        name: Publicação
                        form_id: null
                      - id: 170
                        name: Análise de Resultados
                        form_id: null
                      - id: 171
                        name: Finalização
                        form_id: null
                    funnel_form: null
                    business_area: null
                    created_at: '2026-02-08T23:44:18-03:00'
                    updated_at: '2026-02-08T23:44:18-03:00'
                  counts:
                    total_steps: 6
                    total_projects: 50
                    active_projects: 50
                    tags_count: 2
                    attachments_count: 0
                  steps_distribution:
                    - step_id: 167
                      step_name: Em Andamento
                      projects_count: 11
                      projects_entry_in_period: 19
                      projects_exit_in_period: 12
                    - step_id: 166
                      step_name: Backlog
                      projects_count: 9
                      projects_entry_in_period: 21
                      projects_exit_in_period: 13
                    - step_id: 168
                      step_name: Correção
                      projects_count: 9
                      projects_entry_in_period: 11
                      projects_exit_in_period: 9
                    - step_id: 169
                      step_name: Publicação
                      projects_count: 8
                      projects_entry_in_period: 7
                      projects_exit_in_period: 5
                    - step_id: 171
                      step_name: Finalização
                      projects_count: 7
                      projects_entry_in_period: 5
                      projects_exit_in_period: 0
                    - step_id: 170
                      step_name: Análise de Resultados
                      projects_count: 6
                      projects_entry_in_period: 6
                      projects_exit_in_period: 5
                  steps_summary:
                    most_occupied_step:
                      step_id: 167
                      step_name: Em Andamento
                      step_form_id: null
                      projects_count: 11
                    empty_steps_ids: []
                    empty_steps_count: 0
                  time_metrics:
                    average_time_in_funnel_minutes: 4963.2
                    average_time_per_step_minutes:
                      - step_id: 166
                        step_name: Backlog
                        average_time_minutes: 5643.75
                      - step_id: 167
                        step_name: Em Andamento
                        average_time_minutes: 4472
                      - step_id: 168
                        step_name: Correção
                        average_time_minutes: 5880
                      - step_id: 169
                        step_name: Publicação
                        average_time_minutes: 3372
                      - step_id: 170
                        step_name: Análise de Resultados
                        average_time_minutes: 4200
                      - step_id: 171
                        step_name: Finalização
                        average_time_minutes: 0
                    oldest_project_id: d5f647d1-2df1-451c-96e7-5f577dd3b574
                    newest_project_id: 8812c301-6ed5-4495-a255-34b2d24433e5
                    oldest_project_minutes: 129398.09
                    newest_project_minutes: 963.09
                  activity:
                    last_activity_at: '2026-02-08T17:46:17-03:00'
                    projects_added_in_period: 15
                  tags:
                    - id: 1
                      name: Bixa prioridade
                      color: '#28a745'
                      projects_count: 0
                    - id: 2
                      name: Alta prioridade
                      color: '#ffc107'
                      projects_count: 0
                  funnel_status: []
                  attachments: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````