Indicadores, metas e relatórios

indicators_overview

Indicadores do período. Funil, conversão, ciclos, previsão (forecast), meta, cobertura, motivos de perda, temperatura e carteira aberta do período, completos. Admin e líder veem o time (com filtro por donos); o vendedor vê só os próprios números. Para uma resposta curta, forecast_month, goal_pace, funnel_period e loss_reasons já trazem o recorte. Os números são calculados depois de cada sincronização do CRM e a cada hora, não na chamada.

Operação	indicators.overview — a mesma de GET /v1/indicators/overview
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
period	"current" | "last-month" | "last-2-months" | "last-3-months" | "last-3-months-to-date"	não	current = this month so far; last-month, last-2-months, last-3-months = closed months ending before this one; last-3-months-to-date = from the same day three months ago through today, in the company time zone, compared with the three months before it (padrão "current")
ownerIds	string	não	Comma-separated CRM owner ids. Absent = the whole team, including deals without owner (formato ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$)
pipelineId	string (uuid)	não	Pipeline (funnel) in analysis. Absent = every funnel, the number of today. A pipeline out of analysis answers the same numbers of “every funnel” with funnelScope.pipelineId null.
pipelineIds	string	não	Comma-separated pipelines (funnels) in analysis, read together: every number is the sum of those funnels. Takes precedence over pipelineId. Pipelines out of analysis are ignored; none left, or every funnel in analysis, is the same as absent (funnelScope.pipelineIds empty) (formato ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}(,[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})*$)

Resultado

O JSON da resposta de sucesso de GET /v1/indicators/overview, com os mesmos campos.

indicators_reps

Vendedores do time. Cada dono do CRM com negócios nos funis em análise neste mês ou com meta, com meta, commit, upside e disciplina de tarefas. Traz o ownerId que indicators_rep recebe. Só admin e líder de vendas. Os números são calculados depois de cada sincronização do CRM e a cada hora, não na chamada.

Operação	indicators.reps — a mesma de GET /v1/indicators/reps
Escopo	context:read
Papéis	admin, líder de vendas
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
pipelineId	string (uuid)	não	Pipeline (funnel) in analysis. Absent = every funnel, the number of today. A pipeline out of analysis answers the same numbers of “every funnel” with funnelScope.pipelineId null.

Resultado

O JSON da resposta de sucesso de GET /v1/indicators/reps, com os mesmos campos.

indicators_rep

Painel de um vendedor. O vendedor contra o time e contra o próprio mês anterior: meta com commit e upside, maiores negócios abertos, comparações por métrica, funil e motivos de perda. O vendedor só abre o próprio painel. Os números são calculados depois de cada sincronização do CRM e a cada hora, não na chamada.

Operação	indicators.rep — a mesma de GET /v1/indicators/reps/{ownerId}
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
ownerId	string (uuid)	sim	Id do dono no CRM, como indicators_reps devolve
pipelineId	string (uuid)	não	Pipeline (funnel) in analysis. Absent = every funnel, the number of today. A pipeline out of analysis answers the same numbers of “every funnel” with funnelScope.pipelineId null.

Resultado

O JSON da resposta de sucesso de GET /v1/indicators/reps/{ownerId}, com os mesmos campos.

goals_board

Metas do mês. A meta de cada dono e a do time no mês. Metas do CRM têm prioridade quando o mês tem alguma; sem elas, valem as definidas no Nexo. Todo dono ativo aparece, com nulo para “sem meta”. Só admin e líder de vendas.

Operação	goals.board — a mesma de GET /v1/goals
Escopo	context:read
Papéis	admin, líder de vendas
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
month	string	sim	Month in the company calendar, YYYY-MM (formato ^\d{4}-(0[1-9]|1[0-2])$)

Resultado

O JSON da resposta de sucesso de GET /v1/goals, com os mesmos campos.

monthly_report

Relatório do mês do time. O relatório consolidado do mês, refeito todo dia às 7h: meta e ritmo, onde o funil trava, um bloco por vendedor, pendências e o que foi bem. Sem month vem o mais recente; com month (AAAA-MM), o daquele mês. Só admin e líder de vendas.

Operação	reports.monthly — a mesma de GET /v1/reports/monthly
Escopo	context:read
Papéis	admin, líder de vendas
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
month	string	não	Mês da leitura guardada, AAAA-MM. Ausente = o relatório mais recente (formato ^\d{4}-(0[1-9]|1[0-2])$)

Resultado

O JSON da resposta de sucesso de GET /v1/reports/monthly, com os mesmos campos.

monthly_report_mine

Relatório do mês do vendedor. Só o bloco do vendedor dono do token no relatório mais recente: carteira, riscos, pendências e o parecer do Nexo. null quando a pessoa ainda não tem dono do CRM ligado.

Operação	reports.monthly.mine — a mesma de GET /v1/reports/monthly/mine
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Nenhum argumento.

Resultado

O JSON da resposta de sucesso de GET /v1/reports/monthly/mine, com os mesmos campos.

forecast_month

Forecast do mês. Forecast do mês corrente: negócios abertos com fechamento previsto no mês por categoria (commit, melhor caso, pipeline, não classificados), total, ponderado, piso (realizado + commit) contra a meta e o que precisa vir do melhor caso. Do time ou de um vendedor. É a mesma consulta que o copiloto do Nexo faz, na visibilidade da pessoa; não roda IA.

Operação	indicators.forecast — consulta do copiloto, sem rota /v1
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
vendedor	string	não	Nome do vendedor como aparece na lista do time. Sem ele, a consulta é do time inteiro (mín. 1 caractere; máx. 120 caracteres)

Resultado

Um JSON compacto em português, o mesmo que o copiloto do Nexo recebe para esta consulta. Não há rota /v1 equivalente.

goal_pace

Meta e ritmo. Meta, realizado, quanto falta, atingimento, ritmo esperado até hoje e desvio, e cobertura (pipeline aberto ÷ o que falta). Do time ou de um vendedor, no período pedido. Consultando o time, traz também meta, realizado, falta e atingimento de cada vendedor. É a mesma consulta que o copiloto do Nexo faz, na visibilidade da pessoa; não roda IA.

Operação	goals.pace — consulta do copiloto, sem rota /v1
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
periodo	"current" | "last-month" | "last-2-months" | "last-3-months" | "last-3-months-to-date"	não	current = mês corrente até hoje (padrão); last-month = mês passado; last-2-months e last-3-months = os 2 ou 3 meses fechados antes deste; last-3-months-to-date = dos últimos 3 meses até hoje
vendedor	string	não	Nome do vendedor como aparece na lista do time. Sem ele, a consulta é do time inteiro (mín. 1 caractere; máx. 120 caracteres)

Resultado

Um JSON compacto em português, o mesmo que o copiloto do Nexo recebe para esta consulta. Não há rota /v1 equivalente.

funnel_period

Funil do período. Funil de passagem do período: quantos negócios entraram em cada fase, quantos avançaram, pararam ou seguem em jogo, a conversão de cada degrau contra o histórico da própria empresa nos últimos 12 meses; a referência Winning só entra quando a empresa ainda não tem base suficiente, e nesse caso a origem externa vem identificada. Também traz os furos (degraus bem abaixo da referência) e os atalhos até o ganho. É a mesma consulta que o copiloto do Nexo faz, na visibilidade da pessoa; não roda IA.

Operação	indicators.funnel — consulta do copiloto, sem rota /v1
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
periodo	"current" | "last-month" | "last-2-months" | "last-3-months" | "last-3-months-to-date"	não	current = mês corrente até hoje (padrão); last-month = mês passado; last-2-months e last-3-months = os 2 ou 3 meses fechados antes deste; last-3-months-to-date = dos últimos 3 meses até hoje
vendedor	string	não	Nome do vendedor como aparece na lista do time. Sem ele, a consulta é do time inteiro (mín. 1 caractere; máx. 120 caracteres)

Resultado

Um JSON compacto em português, o mesmo que o copiloto do Nexo recebe para esta consulta. Não há rota /v1 equivalente.

coverage_conversion

Cobertura e conversão. Negócios ganhos, perdidos e decididos no período, taxa de conversão (ganhos ÷ decididos), cobertura necessária (1 ÷ conversão), cobertura atual sobre o que falta da meta, valor ganho, pipeline aberto agora e ciclo para ganhar e para perder. Consultando o time, traz a conversão de cada vendedor. Para comparar meses, consulte uma vez por período. É a mesma consulta que o copiloto do Nexo faz, na visibilidade da pessoa; não roda IA.

Operação	indicators.coverage — consulta do copiloto, sem rota /v1
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
periodo	"current" | "last-month" | "last-2-months" | "last-3-months" | "last-3-months-to-date"	não	current = mês corrente até hoje (padrão); last-month = mês passado; last-2-months e last-3-months = os 2 ou 3 meses fechados antes deste; last-3-months-to-date = dos últimos 3 meses até hoje
vendedor	string	não	Nome do vendedor como aparece na lista do time. Sem ele, a consulta é do time inteiro (mín. 1 caractere; máx. 120 caracteres)

Resultado

Um JSON compacto em português, o mesmo que o copiloto do Nexo recebe para esta consulta. Não há rota /v1 equivalente.

loss_reasons

Motivos de perda. Por que os negócios foram perdidos no período, como o time registrou no CRM: motivos mais frequentes com a participação, concorrentes para quem se perdeu, quanto do campo está preenchido e quais vendedores mais perdem sem registrar o motivo. Responde também em que etapa do funil o negócio morreu, cruzada com o motivo, com a cobertura da etapa. É a mesma consulta que o copiloto do Nexo faz, na visibilidade da pessoa; não roda IA.

Operação	indicators.losses — consulta do copiloto, sem rota /v1
Escopo	context:read
Papéis	admin, líder de vendas, vendedor
Classe de limite	read
Auditada	não
Comportamento	somente leitura · idempotente

Entrada

Campo	Tipo	Obrigatório	Descrição
periodo	"current" | "last-month" | "last-2-months" | "last-3-months" | "last-3-months-to-date"	não	current = mês corrente até hoje (padrão); last-month = mês passado; last-2-months e last-3-months = os 2 ou 3 meses fechados antes deste; last-3-months-to-date = dos últimos 3 meses até hoje
vendedor	string	não	Nome do vendedor como aparece na lista do time. Sem ele, a consulta é do time inteiro (mín. 1 caractere; máx. 120 caracteres)

Resultado

Um JSON compacto em português, o mesmo que o copiloto do Nexo recebe para esta consulta. Não há rota /v1 equivalente.