openthorDocumentação
Abrir o painel

GET /v1/customer-metrics

Métricas por cliente — recência, frequência, valor (RFM) e cadência de compra. · domínio Clientes

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/customer-metrics?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:

  • customer_code — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • municipality_code — numérico (eq · in · gte · lte · gt · lt)
  • days_inactive — numérico (eq · in · gte · lte · gt · lt)
  • value_12m — numérico (eq · in · gte · lte · gt · lt)
  • invoices_12m — numérico (eq · in · gte · lte · gt · lt)
  • purchase_days — numérico (eq · in · gte · lte · gt · lt)

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

Colunas retornadas

  • customer_code — Cliente (cód.)
  • name — Nome
  • rep_code — Vendedor (RCA)
  • last_purchase_at — Última compra
  • days_inactive — Dias sem comprar
  • value_12m — Faturamento 12m (R$)
  • invoices_12m — Notas 12m
  • months_active_12m — Meses ativos (12m)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: value_12m · days_inactive · last_purchase_at · invoices_12m · months_active_12m · customer_code · avg_interval_days · purchase_days. Limite padrão 100, máximo 1000 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