Skip to main content
GET
Gerar dados do relatório do funil

Authorizations

x-jurichat-api-key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header x-jurichat-api-key.

Query Parameters

funnelId
string
required

ID do funil.

Pattern: ^[cC][^\s-]{8,}$
start
string<date-time>

Início do período (ISO 8601, meia-noite local). Exige type. Mesmo formato do filtro do board.

end
string<date-time>

Fim do período (ISO 8601, meia-noite local do último dia). Opcional; sem end filtra a partir de start.

type
enum<string>

Campo filtrado por start/end: criação do card no CRM ou última mensagem.

Available options:
createdAt,
lastInteraction
createdAt
string<date-time>

Legado: filtra cards criados no dia desta data (ISO 8601). Prefira start/end + type.

lastContact
string<date-time>

Legado: filtra pelo último contato no dia desta data (ISO 8601). Prefira start/end + type.

userId
string

Filtra pelo responsável do card.

Pattern: ^[cC][^\s-]{8,}$
tags
string

IDs de etiquetas separados por vírgula.

columnId
string

Filtra por uma coluna do funil.

Pattern: ^[cC][^\s-]{8,}$
channel
string

Filtra pelo canal do lead.

Busca por nome, e-mail ou telefone do contato.

showOnlyUnread
boolean

Quando verdadeiro, considera apenas os cards cujo contato tem mensagem não lida.

sortField
enum<string>

Campo de ordenação dos cards.

Available options:
manual,
name,
createdAt,
lastInteraction
sortOrder
enum<string>

Direção da ordenação.

Available options:
asc,
desc

Response

Default Response

funnel
object
required
data
object[]
required