Skip to main content
As mesmas contas da aba Gerencial da tela de Propostas, para levar ao seu BI ou planilha: quantas propostas chegaram, quanto foi aprovado e emitido, onde elas param e quanto tempo cada etapa leva.
Resumo: GET /v1/proposals/dashboard devolve indicadores, funil, quebras e SLA de um período. GET /v1/proposals/dashboard/rows devolve as propostas desse período, uma por linha, até 5.000. Autenticação, módulo e erros comuns estão na visão geral.

Período e filtros

As duas rotas aceitam os mesmos filtros. O período conta pela data de criação da proposta.
string
Início do período, em ISO 8601 (por exemplo, 2026-09-05T00:00:00-03:00). Ausente: 30 dias antes de to.
string
Fim do período, exclusivo, em ISO 8601. Ausente: o fim do dia de hoje, no horário de Brasília. O período vai até 366 dias.
string
Origens, separadas por vírgula: PUBLIC_FORM, OPERATOR, API, BATCH, CRM e CHANNEL. CHANNEL é a proposta que veio do canal de correspondentes; ela conta só como CHANNEL, nunca pela origem de cadastro.
string
Ids de correspondente, separados por vírgula.
string
Ids de atendente do correspondente, separados por vírgula.
string
Chaves de produto, separadas por vírgula.
string
Ids de carteira, separados por vírgula.
string
COMPANY, PERSON ou os dois, separados por vírgula.
string
Situações da proposta, separadas por vírgula. Valores em Situações da proposta.
Cada filtro de lista aceita até 2.000 caracteres. Os números ficam guardados por até 60 segundos: a mesma consulta repetida nesse intervalo devolve o mesmo resultado.

Ler os indicadores

Além dos filtros acima, esta rota aceita:
string
default:"true"
true calcula também o período anterior, do mesmo tamanho e imediatamente antes. false devolve os blocos prev zerados.
string
default:"correspondent"
Quebra do bloco breakdown: correspondent, agent, product, portfolio, origin ou entityType.
string
Dias tolerados em cada situação aberta, no formato SITUAÇÃO:dias separado por vírgula. Situações aceitas: DRAFT, IN_ANALYSIS, WAITING_CUSTOMER e WAITING_OPERATOR. O rascunho só conta como aberto quando aparece aqui.
O exemplo está resumido: weekStarts e as listas semanais têm uma posição por semana, e weekly, statusWeekly, funnel.prev e os demais itens de cycle e aging.rows foram cortados.

Indicadores

kpis.cur vale para o período pedido; kpis.prev, para o período anterior. Sem dado, o indicador sai 0.

Blocos da resposta

object
Período pedido (from, to), período anterior (prevFrom, prevTo) e weekStarts: as segundas-feiras, à meia-noite de Brasília, das semanas da série. A série cobre o período ou, se ele for menor, as 12 últimas semanas até to.
object
cur e prev, cada um com os nove indicadores como listas, uma posição por semana de weekStarts. Em prev, a mesma janela deslocada pelo tamanho do período.
object[]
Por semana de criação: weekStart, issued (emitidas), open (ainda abertas, rascunho incluído), rejected (recusadas) e closed (vencidas ou canceladas), pela situação de hoje.
object
cur e prev, seis etapas: 0 recebida, 1 analisada, 2 pré-aprovada, 3 oferta firme, 4 oferta escolhida, 5 emitida. count são as propostas que chegaram pelo menos à etapa; valueCents soma o valor pedido até a etapa 2 e o valor ofertado da 3 em diante.
object
A quebra pedida em dim. Cada linha tem key (o id, a chave ou o valor da dimensão; null agrupa as propostas sem ele), label (só para product e portfolio), os indicadores cur e prev e weekly, com as propostas recebidas nas últimas 12 semanas da série. Ordem: mais recebidas primeiro.
object[]
Por produto, no período: productKey, productName, count e requestedCents. Mais propostas primeiro.
object[]
Tempo entre etapas, no período: pair (RECEIVED_ANALYZED, ANALYZED_PREAPPROVED, PREAPPROVED_FIRM, FIRM_CHOSEN ou CHOSEN_ISSUED), medianDays, p90Days e n (propostas medidas). Durações de 120 dias ou mais entram juntas no último balde de 120 dias.
object
No período: firm (com oferta firme), chosen (com oferta escolhida), expiredWithoutChoice (vencidas com oferta e sem escolha), chosenAmountCents (soma escolhida), requestedOfChosenCents (soma pedida dessas mesmas propostas), byCustomer e byOperator (quem registrou a escolha).
object
Recusadas no período: total, requestedCents e rows, com step (a etapa da esteira que reprovou, ou a seção da política quando não houve esteira; null quando não se sabe) e count.
object
Retrato das propostas abertas agora, com os filtros mas sem o período. rows traz, por situação aberta, slaDays, upTo2, upTo7 e over7 (dias na situação), total e outOfSla. oldest traz as 5 há mais tempo na situação: id, name, document, status, days, correspondentId e origin.
string
Quando os números foram calculados.

Exportar as propostas do período

Devolve as propostas criadas no período, uma por linha, com os mesmos filtros dos indicadores. Mais recentes primeiro, até 5.000 linhas. É a mesma base da planilha que a aba Gerencial exporta.
string
O período aplicado, já com os padrões preenchidos.
object[]
Uma proposta por linha.
boolean
true quando o período tem mais propostas que o teto. Divida o período ou use mais filtros.
integer
O teto de linhas: 5000.
Os parâmetros compare, dim e sla não mudam as linhas.