`GET /v1/agg/customers/coverage-by-city`

Cobertura de clientes por município. · domínio Clientes

Exemplo

cURL

curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/customers/coverage-by-city?limit=5"

A autenticação e o formato do envelope { data, meta } são comuns a todos os endpoints — veja Autenticação e Resposta e metadados.

Filtros e período

Campos filtráveis com a sintaxe campo=op:valor:

rep_code — numérico (eq · in · gte · lte · gt · lt)
customer_code — numérico (eq · in · gte · lte · gt · lt)

Sem janela de datas — este endpoint é um retrato do momento (from/to não se aplicam).

Métricas

Selecione com metrics=m1,m2 (padrão: todas):

registered — Cadastrados
active — Ativos
positivacao_pct — Positivação (%)
value — Faturamento (R$)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: registered · active · value. Limite padrão 50, máximo 500 linhas por chamada; pagine com offset enquanto meta.has_more for true.

O que sua chave enxerga

O recorte da credencial (filial, vendedor, cliente, fornecedor, janela de datas) é aplicado no servidor e não pode ser ampliado por filtros — dois usuários podem ver totais diferentes no mesmo endpoint, por desenho.

Ferramentas MCP sobre este endpoint

get_coverage_by_city — Cobertura por município

Esta página ajudou? Conte para a gente — lemos tudo.