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

# Gerar dados do relatório do funil

> Retorna os dados filtrados do funil de CRM usados nos relatórios em PDF e Excel.



## OpenAPI

````yaml https://api.jurichat.com/docs/client/openapi.json get /funnel-column/report
openapi: 3.1.0
info:
  title: JuriChat API — Documentação para Integradores
  description: ''
  version: 1.0.0
servers:
  - url: https://api.jurichat.com
    description: Production server
security:
  - apiKeyAuth: []
tags: []
paths:
  /funnel-column/report:
    get:
      tags:
        - CRM
      summary: Gerar dados do relatório do funil
      description: >-
        Retorna os dados filtrados do funil de CRM usados nos relatórios em PDF
        e Excel.
      parameters:
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: funnelId
          required: true
          description: ID do funil.
        - schema:
            type: string
            format: date-time
          in: query
          name: start
          required: false
          description: >-
            Início do período (ISO 8601, meia-noite local). Exige type. Mesmo
            formato do filtro do board.
        - schema:
            type: string
            format: date-time
          in: query
          name: end
          required: false
          description: >-
            Fim do período (ISO 8601, meia-noite local do último dia). Opcional;
            sem end filtra a partir de start.
        - schema:
            type: string
            enum:
              - createdAt
              - lastInteraction
          in: query
          name: type
          required: false
          description: >-
            Campo filtrado por start/end: criação do card no CRM ou última
            mensagem.
        - schema:
            type: string
            format: date-time
          in: query
          name: createdAt
          required: false
          description: >-
            Legado: filtra cards criados no dia desta data (ISO 8601). Prefira
            start/end + type.
        - schema:
            type: string
            format: date-time
          in: query
          name: lastContact
          required: false
          description: >-
            Legado: filtra pelo último contato no dia desta data (ISO 8601).
            Prefira start/end + type.
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: userId
          required: false
          description: Filtra pelo responsável do card.
        - schema:
            type: string
          in: query
          name: tags
          required: false
          description: IDs de etiquetas separados por vírgula.
        - schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
          in: query
          name: columnId
          required: false
          description: Filtra por uma coluna do funil.
        - schema:
            type: string
          in: query
          name: channel
          required: false
          description: Filtra pelo canal do lead.
        - schema:
            type: string
          in: query
          name: search
          required: false
          description: Busca por nome, e-mail ou telefone do contato.
        - schema:
            type: boolean
          in: query
          name: showOnlyUnread
          required: false
          description: >-
            Quando verdadeiro, considera apenas os cards cujo contato tem
            mensagem não lida.
        - schema:
            type: string
            enum:
              - manual
              - name
              - createdAt
              - lastInteraction
          in: query
          name: sortField
          required: false
          description: Campo de ordenação dos cards.
        - schema:
            type: string
            enum:
              - asc
              - desc
          in: query
          name: sortOrder
          required: false
          description: Direção da ordenação.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  funnel:
                    type: object
                    properties:
                      id:
                        type: string
                        pattern: ^[cC][^\s-]{8,}$
                      name:
                        type: string
                    required:
                      - id
                      - name
                    additionalProperties: false
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          pattern: ^[cC][^\s-]{8,}$
                        columnId:
                          type: string
                          pattern: ^[cC][^\s-]{8,}$
                        columnName:
                          type: string
                        channel:
                          type: string
                          nullable: true
                        user:
                          type: object
                          properties:
                            id:
                              type: string
                              pattern: ^[cC][^\s-]{8,}$
                            name:
                              type: string
                              nullable: true
                            imageUrl:
                              type: string
                              nullable: true
                              description: Foto de perfil. Null se não houver.
                          required:
                            - id
                            - name
                            - imageUrl
                          additionalProperties: false
                          nullable: true
                        person:
                          type: object
                          properties:
                            id:
                              type: string
                              pattern: ^[cC][^\s-]{8,}$
                            name:
                              type: string
                              nullable: true
                            email:
                              type: string
                              nullable: true
                            phoneNumber:
                              type: string
                              nullable: true
                          required:
                            - id
                            - name
                            - email
                            - phoneNumber
                          additionalProperties: false
                        customFields:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                pattern: ^[cC][^\s-]{8,}$
                              value:
                                anyOf:
                                  - anyOf:
                                      - type: string
                                      - type: number
                                      - type: boolean
                                    nullable: true
                                  - type: array
                                    items:
                                      anyOf:
                                        - type: string
                                        - type: number
                                        - type: boolean
                                      nullable: true
                                  - type: array
                                    items:
                                      type: object
                                      additionalProperties:
                                        anyOf:
                                          - type: string
                                          - type: number
                                          - type: boolean
                                        nullable: true
                                  - type: object
                                    additionalProperties:
                                      anyOf:
                                        - type: string
                                        - type: number
                                        - type: boolean
                                      nullable: true
                            required:
                              - id
                              - value
                            additionalProperties: false
                        tags:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                pattern: ^[cC][^\s-]{8,}$
                              name:
                                type: string
                            required:
                              - id
                              - name
                            additionalProperties: false
                        legalArea:
                          type: object
                          properties:
                            id:
                              type: string
                              pattern: ^[cC][^\s-]{8,}$
                            name:
                              type: string
                          required:
                            - id
                            - name
                          additionalProperties: false
                          nullable: true
                        createdAt:
                          type: string
                          format: date-time
                        lastInteractionAt:
                          type: string
                          format: date-time
                          nullable: true
                      required:
                        - id
                        - columnId
                        - columnName
                        - channel
                        - user
                        - person
                        - customFields
                        - tags
                        - legalArea
                        - createdAt
                        - lastInteractionAt
                      additionalProperties: false
                required:
                  - funnel
                  - data
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                  code:
                    type: string
                  details:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: object
                        properties: {}
                        additionalProperties: true
                    description: Detalhes adicionais do erro.
                required:
                  - message
                  - statusCode
                additionalProperties: false
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-jurichat-api-key
      description: >-
        Chave de API do escritório (criada no painel). Envie o valor no header
        x-jurichat-api-key.

````