v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB
Dashboard

Listar Safra

Esta seção está atrelada à consulta das métricas de Safra 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/Harvest

Query parameters

dataInicialstring date required

Formato YYYY-MM-DD

dataFinalstring date required

Formato YYYY-MM-DD

Response

Operação realizada com sucesso

namestring

Nome da etapa

{"stackTrail":"paths:/Harvest:get:responses:200:content:application/json:schema:items:properties:converted","oasType":"schema","type":"unknown","description":"quantidade de leads convertidos"}
{"stackTrail":"paths:/Harvest:get:responses:200:content:application/json:schema:items:properties:restarted","oasType":"schema","type":"unknown","description":"quantidade de leads reiniciados"}
{"stackTrail":"paths:/Harvest:get:responses:200:content:application/json:schema:items:properties:conversionRate","oasType":"schema","type":"unknown","description":"percentual de conversão"}
{"stackTrail":"paths:/Harvest:get:responses:200:content:application/json:schema:items:properties:parked","oasType":"schema","type":"unknown","description":"quantidade de leads estacionados"}
{"stackTrail":"paths:/Harvest:get:responses:200:content:application/json:schema:items:properties:discarded","oasType":"schema","type":"unknown","description":"quantidade de leads descartados"}
totalinteger

quantidade total de leads

gateTypestring

gatilho de saída da etapa

idinteger

identificador da etapa