Pular para o conteúdo

Vendedores do time

GET
/v1/indicators/reps
curl --request GET \
--url https://mcp-nexo.winningsales.com.br/v1/indicators/reps \
--header 'Authorization: Bearer <token>'

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. Só admin e líder de vendas, como no app. Os números são calculados depois de cada sincronização do CRM e a cada hora: nada é calculado na chamada.

pipelineId

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.

string format: uuid

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.

Vendedores do time

Media typeapplication/json
object
funnelScope
required

Which funnel the numbers refer to, and the funnels that can be chosen

object
pipelineId
required

The funnel the numbers refer to when exactly one is chosen; null otherwise

string format: uuid
nullable
name
required

Funnel name when exactly one is chosen; null otherwise

string
nullable
pipelineIds
required

The funnels the numbers are summed over; empty = every funnel under analysis

Array<string>
options
required

Every funnel under analysis (the sales funnels chosen by the admin), in CRM order, whatever the filter

Array<object>
object
pipelineId
required

Pipeline id

string format: uuid
name
required

Pipeline name in the CRM

string
suggestedKind
required

Post_sales when the name looks like Customer Success, onboarding, implantação, renewal, retention or support

string
Allowed values: sales post_sales
excluded
required

Active funnels out of the analysis (usually post-sales), in CRM order: never in any number, listed for the “Nos números” line

Array<object>
object
pipelineId
required

Pipeline id

string format: uuid
name
required

Pipeline name in the CRM

string
suggestedKind
required

Post_sales when the name looks like Customer Success, onboarding, implantação, renewal, retention or support

string
Allowed values: sales post_sales
reps
required

Every CRM owner with deals in the pipelines under analysis this month or a goal, busiest first; owners whose user is marked as not a person are left out

Array<object>
object
ownerId
required

CRM owner id

string format: uuid
name
required

Owner name from the CRM

string
nullable
isYou
required

True when the CRM owner is linked to the user who asks: a lead or admin who also sells

boolean
attention
required

No_goal = no goal this month; below_goal = realized + declared commit below the goal; null = nothing to flag

string
nullable
Allowed values: no_goal below_goal
discipline
required

Task discipline of the rep in the current period, for the lead to compare across the team without a ranking

object
total
required

Count over the DealTasks table, with its base: done + missed + cancelled + rescheduled + open in the period; no note by AI, no ranking

integer
done
required

Tasks marked as done in the period

integer
missed
required

Tasks missed: the day turned and it was not done

integer
cancelled
required

Tasks the rep cancelled

integer
rescheduled
required

Tasks the rep moved to another day

integer
autoClosed
required

Tasks that closed by themselves because the signal was gone; they do not count against the rep

integer
collection
required

The same cut, only for “cobrar o cliente” tasks

object
total
required

“Cobrar o cliente” tasks (buyer_commitment_due, buyer_deadline_passed) counted against the rep in the period

integer
done
required

Of those, done

integer
missed
required

Of those, missed

integer

Example

{
"funnelScope": {
"options": [
{
"suggestedKind": "sales"
}
],
"excluded": [
{
"suggestedKind": "sales"
}
]
},
"reps": [
{
"attention": "no_goal"
}
]
}

Filtro inválido

Media typeapplication/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 generated

{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"requestId": "example",
"meta": {
"additionalProperty": "example"
}
}

Token ausente, inválido, expirado ou revogado

Media typeapplication/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"
}

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

Media typeapplication/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"
}
}

Limite de chamadas da empresa ou do token atingido

Media typeapplication/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
}
}