openthorDocumentação

GET /v1/agg/goals/by-supplier

Meta × realizado agregado por fornecedor. · domínio Metas

Exemplo

cURL
curl -H "Authorization: Bearer ot_live_SEU_TOKEN_AQUI" \
  "https://api.openthor.dev/v1/agg/goals/by-supplier?from=2026-06-01&to=2026-06-30&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)

Janela de datas: from/to (inclusivos, formato YYYY-MM-DD) sobre period.

Métricas

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

  • target_value — Meta (R$)
  • realized_value — Realizado bruto (R$)
  • realized_net_value — Realizado líquido (R$)
  • pct_attained — % atingido (bruto)
  • pct_attained_net — % atingido (líquido)
  • customers_target — Meta de positivação
  • reps — Vendedores (qtde)

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: target_value · realized_value · realized_net_value · pct_attained · pct_attained_net. Limite padrão 50, máximo 200 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