openthorDocumentação
Abrir o painel

GET /v1/coverage-history

Histórico trimestral de cobertura por fornecedor e município — para achar onde a cobertura caiu vs o trimestre anterior. · domínio Vendas

Exemplo

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

  • supplier_code — numérico (eq · in · gte · lte · gt · lt)
  • municipality_code — numérico (eq · in · gte · lte · gt · lt)
  • quarter_label — 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

  • supplier_code — Fornecedor (cód.)
  • supplier_name — Fornecedor
  • municipality_code — Município (cód.)
  • municipality_name — Município
  • quarter_label
  • registered_count
  • covered_count
  • coverage_pct

Ordenação e paginação

Ordene com sort=coluna (crescente) ou sort=-coluna (decrescente). Colunas ordenáveis: coverage_pct · quarter_label. 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