openthorDocumentação
Abrir o painel

GET /v1/goals

Metas por período e nível (empresa, supervisor, RCA, RCA×fornecedor). · domínio Metas

Exemplo

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

  • goal_level — numérico (eq · in · gte · lte · gt · lt)
  • rep_code — numérico (eq · in · gte · lte · gt · lt)
  • pct_attained — numérico (eq · in · gte · lte · gt · lt)
  • supplier_code — numérico (eq · in · gte · lte · gt · lt)
  • goal_level — texto (somente eq · in)

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

Colunas retornadas

  • period — Período
  • goal_level — Nível da meta
  • rep_code — Vendedor (RCA)
  • target_value — Meta (R$)
  • realized_value — Realizado bruto (R$)
  • pct_attained — % atingido (bruto)
  • gap_value — Falta para a meta (R$)
  • realized_net_value — Realizado líquido (R$)
  • pct_attained_net — % atingido (líquido)
  • customers_target — Meta de positivação
  • customers_realized — Positivação realizada

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: pct_attained · gap_value · target_value · realized_value · period. Limite padrão 100, 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