Ir para o conteúdo principal
Status da rede
Entrar
Piloterr
Voltar à biblioteca

API Stats

Saúde de infraestrutura de um motor ou endpoint na última hora. Não está limitado à sua conta ou tenant. Ativado por conta: HTTP 403 significa contactar o suporte para o ativar.

AtivoGrátisGET/v2/stats
Experimente o endpoint grátisPiloterr

Visão Geral do Endpoint

Documentação detalhada, preços e exemplos de uso.

Visão geralLink to Visão geral

O endpoint Stats devolve um instantâneo de saúde de infraestrutura para um motor de API ou um caminho específico. As métricas são agregadas em toda a plataforma numa janela de uma hora. Não são o uso da sua conta ou tenant. Não há série temporal. Use o endpoint de Usage para a cota da sua conta Piloterr.

Este endpoint é gratuito. Nunca consome créditos.

API Stats é ativado por conta. HTTP 403 significa que não está ativo na sua conta. Contacte o suporte para o ativar.

Início rápidoLink to Início rápido

GET https://api.piloterr.com/v2/stats?engine=website

GET https://api.piloterr.com/v2/stats?path=/v2/website/crawler

A autenticação é feita via cabeçalho x-api-key.

ParâmetrosLink to Parâmetros

Indique pelo menos engine ou path.

Parâmetro Tipo Obrigatório Descrição
engine string não Família de API a verificar, por exemplo website.
path string não Endpoint concreto a verificar, por exemplo /v2/website/crawler. Se também enviar engine, use um endpoint dessa API.
x-api-key string sim Sua chave de API privada Piloterr

Valores de saúdeLink to Valores de saúde

  • operational: taxa de sucesso igual ou superior a 99%
  • degraded: taxa de sucesso de 90% a 99%
  • down: taxa de sucesso inferior a 90%

Campos de respostaLink to Campos de resposta

Campo Tipo Descrição
engine string Identificador do motor do catálogo (por exemplo website)
path string | null Filtro de caminho normalizado, ou null se consultar apenas por motor
health string operational, degraded ou down na última hora
success_rate number Taxa de sucesso da última hora. Apenas HTTP 5xx conta como falha. Janelas de baixo volume são suavizadas.
avg_response_time_ms integer Tempo médio de resposta em milissegundos. Durações acima de 60 segundos são excluídas.
window string Janela de agregação. Sempre 1h.

A resposta não inclui o volume de pedidos nem a contagem bruta de erros.

ErrosLink to Erros

Código Descrição
400 engine e path ausentes, valor inválido, ou caminho que não corresponde a engine
401 Chave de API ausente ou inválida
403 API Stats não está ativado para esta conta. Contacte o suporte para o ativar.
404 Motor desconhecido (ausente do catálogo API)
503 Dados de estado temporariamente indisponíveis

NotasLink to Notas

  • Estas são stats de infraestrutura da plataforma, não stats da sua conta ou tenant. Todos os chamadores autenticados veem o mesmo instantâneo.
  • API Stats é ativado por conta. HTTP 403 significa que não está ativo na sua conta. Contacte o suporte para o ativar.
  • Indique pelo menos engine ou path. Um pedido sem ambos devolve 400.
  • Use Usage (/v2/usage) para os créditos restantes e limites de taxa.

Principais casos de usoLink to Principais casos de uso

  • Bloquear um trabalho em lote quando o motor está degraded ou down
  • Mostrar um distintivo de saúde junto de um endpoint
  • Alertar quando success_rate cair abaixo do seu limiar

Pronto para começar?

Sua API de web scraping está a um clique. Comece com +500 créditos, sem infraestrutura para configurar, sem proxies para gerenciar e sem cartão de crédito necessário.

  • +500 créditos
  • Sem cartão de crédito
  • Todos os endpoints incluídos
Comece grátis (+500 créditos)PiloterrFale com um especialista em dados