Saltar al contenido principal
Estado de la red
Iniciar sesión
Piloterr
Volver a la biblioteca

API de Stats

Salud de infraestructura de un motor o endpoint en la última hora. No está limitado a su cuenta o tenant. Se habilita por cuenta: HTTP 403 significa contactar al soporte para activarlo.

ActivoGratisGET/v2/stats
Prueba el endpoint gratisPiloterr

Resumen del Endpoint

Documentación detallada, precios y ejemplos de uso.

Descripción generalLink to Descripción general

El endpoint Stats devuelve una instantánea de salud de infraestructura para un motor de API o una ruta concreta. Las métricas se agregan en toda la plataforma en una ventana de una hora. No son el uso de su cuenta o tenant. No hay series temporales. Use el endpoint de Usage para la cuota de su cuenta Piloterr.

Este endpoint es gratuito. Nunca consume créditos.

API Stats se habilita por cuenta. HTTP 403 significa que no está activo en su cuenta. Contacte al soporte para activarlo.

Inicio rápidoLink to Inicio rápido

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

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

La autenticación se realiza mediante el encabezado x-api-key.

ParámetrosLink to Parámetros

Indique al menos engine o path.

Parámetro Tipo Requerido Descripción
engine string no Familia de API a comprobar, por ejemplo website.
path string no Endpoint concreto a comprobar, por ejemplo /v2/website/crawler. Si también envía engine, use un endpoint de esa API.
x-api-key string sí Su clave API privada de Piloterr

Valores de saludLink to Valores de salud

  • operational: tasa de éxito igual o superior al 99%
  • degraded: tasa de éxito del 90% al 99%
  • down: tasa de éxito inferior al 90%

Campos de respuestaLink to Campos de respuesta

Campo Tipo Descripción
engine string Identificador del motor del catálogo (por ejemplo website)
path string | null Filtro de ruta normalizado, o null si consulta solo por motor
health string operational, degraded o down en la última hora
success_rate number Tasa de éxito de la última hora. Solo HTTP 5xx cuenta como fallo. Las ventanas de bajo volumen se suavizan.
avg_response_time_ms integer Tiempo de respuesta medio en milisegundos. Se excluyen duraciones superiores a 60 segundos.
window string Ventana de agregación. Siempre 1h.

La respuesta no incluye el volumen de solicitudes ni el recuento bruto de errores.

ErroresLink to Errores

Código Descripción
400 Faltan engine y path, valor inválido, o la ruta no coincide con engine
401 Clave API ausente o inválida
403 API Stats no está habilitado para esta cuenta. Contacte al soporte para activarlo.
404 Motor desconocido (no está en el catálogo API)
503 Datos de estado temporalmente no disponibles

NotasLink to Notas

  • Estas son stats de infraestructura de la plataforma, no stats de su cuenta o tenant. Todos los llamantes autenticados ven la misma instantánea.
  • API Stats se habilita por cuenta. HTTP 403 significa que no está activo en su cuenta. Contacte al soporte para activarlo.
  • Indique al menos engine o path. Una solicitud sin ambos devuelve 400.
  • Use Usage (/v2/usage) para sus créditos restantes y límites de tasa.

Casos de uso principalesLink to Casos de uso principales

  • Bloquear un trabajo por lotes cuando el motor está degraded o down
  • Mostrar un distintivo de salud junto a un endpoint
  • Alertar cuando success_rate baje de su umbral

¿Listo para empezar?

Tu API de web scraping está a un clic. Comienza con +500 créditos, sin infraestructura que configurar, sin proxies que gestionar y sin necesidad de tarjeta de crédito.

  • +500 créditos
  • Sin tarjeta de crédito
  • Todos los endpoints incluidos
Empieza gratis (+500 créditos)PiloterrHabla con un experto en datos