Relatório do mês do vendedor

GET

/v1/reports/monthly/mine

const url = 'https://developers.nexo.winningsales.com.br/v1/reports/monthly/mine';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://developers.nexo.winningsales.com.br/v1/reports/monthly/mine \
  --header 'Authorization: Bearer <token>'

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

Authorizations

bearer

Responses

200

O bloco do vendedor, ou null

application/json

object

report

required

O relatório dele; null antes do primeiro cálculo, quando o usuário não tem dono do CRM ligado, ou quando ele não aparece no relatório do mês (ver outdated)

object

month

required

Mês do relatório, AAAA-MM

string

writtenAt

required

Quando o relatório foi escrito, ISO 8601

string

currency

required

Moeda dos valores do bloco dele

string

withheld

required

True quando o conferidor recusou o texto do mês; a tela mostra só os números

boolean

note

required

O parecer do Nexo sobre ele, a partir dos números dele; null quando o texto foi retido

string

nullable

rep

required

O bloco dele no relatório do mês, o mesmo que o líder vê

object

ownerId

required

Dono no CRM

string

name

required

Nome do vendedor como está no CRM

string

goalInCents

required

Meta do mês; null quando não foi definida

number

nullable

realizedInCents

required

Realizado no mês

number

attainment

required

Atingimento em percentual, 0 a 100

number

nullable

conversion

required

Conversão dele contra a do time

object

rep

required

O número do vendedor

number

nullable

team

required

O mesmo número do time inteiro, para comparar

number

nullable

base

required

Quantos negócios ou reuniões entraram na conta dele

integer

cycleDays

required

Ciclo mediano até ganhar

object

rep

required

O número do vendedor

number

nullable

team

required

O mesmo número do time inteiro, para comparar

number

nullable

base

required

Quantos negócios ou reuniões entraram na conta dele

integer

noShowRate

required

Reuniões marcadas que não aconteceram

object

rep

required

O número do vendedor

number

nullable

team

required

O mesmo número do time inteiro, para comparar

number

nullable

base

required

Quantos negócios ou reuniões entraram na conta dele

integer

stageHole

A etapa do CRM onde o funil dele mais trava contra o time

object

pipelineName

required

Funil do CRM onde está a etapa

string

stageName

required

Etapa real do CRM onde ele mais trava contra o time

string

nextName

required

Etapa seguinte; Ganho na última

string

rate

required

Quanto passa com ele, em percentual

number

teamRate

required

A mesma passagem no time

number

pointsBelowTeam

required

Quantos pontos ele está abaixo do time nessa passagem; negativo porque é furo

number

base

required

Negócios decididos dele nessa etapa

integer

stopped

required

Negócios que pararam nessa etapa com ele

integer

reference

required

A mesma passagem no histórico dele ou na referência Winning; null sem referência

number

nullable

referenceSource

required

De onde vem a referência: o histórico de 12 meses dele, ou a tabela da Winning quando ele ainda não tem 8 decididos nessa passagem; null quando não há referência

string

nullable

Allowed values: history winning

icp

required

Como os negócios trabalhados dele se dividem contra o perfil de cliente

object

inside

required

integer

partial

required

integer

outside

required

integer

unknown

required

integer

deals

required

integer

atRiskCount

required

Negócios dele em risco agora

integer

atRiskInCents

required

Quanto está em risco

number

lossesWithoutReason

required

Perdas dele sem motivo preenchido

integer

lossStage

Etapa em que ele mais perde, quando a base sustenta o percentual

object

name

required

Nome da etapa onde ele mais perde

string

count

required

Perdas dele nessa etapa

integer

lost

required

Perdas dele no funil dessa etapa

integer

share

required

Count ÷ lost em percentual

integer

tasksOnTime

Tarefas do Meu dia feitas no prazo, contra o total que já venceu; null quando não há tarefa vencida

object

part

required

integer

base

required

integer

rate

required

number

nullable

followUpsOnTime

Follow-ups de compromisso e cobrança no prazo, contra o total que já venceu; null quando não há follow-up vencido

object

part

required

integer

base

required

integer

rate

required

number

nullable

points

required

Até três pontos das conversas gravadas dele

Array<object>

object

kind

required

Tipo do ponto: objeção aberta, sem próximo passo, compromisso atrasado, condição prometida, diagnóstico

string

dealName

required

Negócio de onde saiu

string

detail

required

O que a conversa mostra, na leitura do Nexo

string

amountInCents

required

Valor do negócio em centavos

number

nullable

source

Conversa de onde saiu o trecho; null quando não veio de uma conversa

object

channel

required

Canal de onde saiu o trecho

string

Allowed values: meeting note call email whatsapp crm_whatsapp

conversationId

required

Id da conversa: a reunião, a sessão de WhatsApp, ou o engajamento do CRM

string

excerptRefs

required

Trechos da conversa que sustentam o ponto

Array<string>

quotes

required

Até duas falas que sustentam o ponto; vazio quando a transcrição já saiu da retenção

Array<object>

object

text

required

O que foi dito, como está na transcrição ou na mensagem

string

speakerName

required

Quem falou, com o nome que aparece na conversa

string

nullable

speakerSide

required

De que lado a pessoa está: internal (da empresa) ou external (do cliente)

string

Allowed values: internal external unknown

channel

required

Canal de onde saiu a fala

string

Allowed values: meeting note call email whatsapp crm_whatsapp

startMs

required

Em que momento da reunião a fala começa, em milissegundos; null fora de reunião

integer

nullable

required

Quando a mensagem foi enviada, ISO 8601; null em reunião, onde vale startMs

string

nullable

outdated

required

Preenchido quando existe relatório gravado num formato anterior ao atual; ele é refeito na próxima rodada das 7h. null quando o report veio ou nunca houve cálculo

object

month

required

Mês do relatório gravado, AAAA-MM

string

writtenAt

required

Quando foi escrito, ISO 8601

string

Example

{
  "report": {
    "rep": {
      "stageHole": null,
      "lossStage": null,
      "tasksOnTime": null,
      "followUpsOnTime": null,
      "points": [
        {
          "source": null,
          "quotes": [
            {
              "speakerSide": "internal",
              "channel": "meeting"
            }
          ]
        }
      ]
    }
  }
}

401

Token ausente, inválido, expirado ou revogado

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.invalid_credential",
  "title": "InvalidCredentialError",
  "status": 401,
  "detail": "Token de acesso inválido, expirado ou revogado. Crie um novo token de acesso no Nexo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb"
}

403

Papel, escopo do token ou plano não permitem a operação

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.insufficient_scope",
  "title": "InsufficientScopeError",
  "status": 403,
  "detail": "Este token não tem o escopo conversations:read, exigido por esta operação. Gere um token com esse escopo.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "operation": "conversations.reading",
    "scope": "conversations:read"
  }
}

429

Limite de chamadas da empresa ou do token atingido

application/json

object

type

required

Stable machine-readable error code (e.g. identity.email_already_in_use)

string

title

required

Error class name

string

status

required

HTTP status code

integer

detail

required

Human-readable message, safe to display to end users

string

requestId

required

Correlation id — send it to support to locate the full trail

string

nullable

meta

Structured details safe for the frontend (field errors, ids)

object

key

additional properties

Example

{
  "type": "public_api.rate_limited",
  "title": "PublicRateLimitedError",
  "status": 429,
  "detail": "Muitas chamadas em pouco tempo. Tente de novo em 12 segundos.",
  "requestId": "019fcae7-3e54-755a-8458-bdb605b324bb",
  "meta": {
    "class": "content",
    "limitedBy": "company",
    "limit": 120,
    "windowSeconds": 60,
    "retryAfterSeconds": 12
  }
}