v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

Dashboard

Listar atividades no funil (gerencial)

Esta seção está atrelada à consulta das métricas de atividades no Funil Gerencial do Dashboard do Spotter, com base no período informado nos parâmetros da URL. O parâmetro de período (dataInicial e dataFinal) é obrigatório para a execução da consulta. O parâmetro funilId é opcional; caso não informado, serão utilizados os dados do funil configurado como padrão para a empresa. A consulta não considera a regra de segmentação configurada nos cards do Dashboard, retornando dados brutos e consolidados para o período especificado. + Parâmetros obrigatório + Parâmetros opcionais + Campos mostrados na listagem:

get/FunnelActivity

Query parameters

dataInicialstring date required

Formato YYYY-MM-DD

dataFinalstring date required

Formato YYYY-MM-DD

Response

Operação realizada com sucesso

convertedinteger

Quantidade de leads que ingressaram nesta etapa.

discardedinteger

Quantidade de leads descartados nesta etapa.

{"stackTrail":"paths:/FunnelActivity:get:responses:200:content:application/json:schema:items:properties:conversionRate","oasType":"schema","type":"unknown","description":"Percentual de leads que avançaram para a próxima etapa, considerando apenas as conversões."}

namestring

Nome da etapa.

{"stackTrail":"paths:/FunnelActivity:get:responses:200:content:application/json:schema:items:properties:questionnaire","oasType":"schema","type":"unknown","description":"Nome do questionário associado à etapa (aplicável para etapas de filtro ou feedback)."}

{"stackTrail":"paths:/FunnelActivity:get:responses:200:content:application/json:schema:items:properties:previousGate","oasType":"schema","type":"unknown","description":"Gate correspondente à saída da etapa anterior e entrada nesta etapa."}

idinteger

Identificador único da etapa.