Le point d'accès Stats renvoie un instantané de santé d'infrastructure pour un moteur API ou un chemin précis. Les métriques sont agrégées sur toute la plateforme, sur une fenêtre d'une heure. Ce n'est pas l'usage de votre compte ou tenant. Il n'y a pas de série temporelle. Utilisez le point d'accès Usage pour le quota de votre compte Piloterr.
Ce point d'accès est gratuit. Il ne consomme jamais de crédit.
API Stats est activé par compte. Un HTTP 403 signifie qu'il n'est pas actif sur votre compte. Contactez le support pour l'activer.
GET https://api.piloterr.com/v2/stats?engine=website
GET https://api.piloterr.com/v2/stats?path=/v2/website/crawler
L'authentification s'effectue via l'en-tête x-api-key.
Fournissez au moins engine ou path.
| Paramètre |
Type |
Requis |
Description |
engine |
string |
non |
Famille d'API à vérifier, par exemple website. |
path |
string |
non |
Point d'accès précis à vérifier, par exemple /v2/website/crawler. Si vous passez aussi engine, utilisez un point d'accès de cette API. |
x-api-key |
string |
oui |
Votre clé API privée Piloterr |
operational : taux de succès supérieur ou égal à 99 %
degraded : taux de succès de 90 % à 99 %
down : taux de succès inférieur à 90 %
| Champ |
Type |
Description |
engine |
string |
Identifiant du moteur issu du catalogue (par exemple website) |
path |
string | null |
Filtre de chemin normalisé, ou null si vous interrogez uniquement par moteur |
health |
string |
operational, degraded ou down sur la dernière heure |
success_rate |
number |
Taux de succès sur la dernière heure. Seuls les HTTP 5xx comptent comme échec. Les fenêtres à faible volume sont lissées. |
avg_response_time_ms |
integer |
Temps de réponse moyen en millisecondes. Les durées au-delà de 60 secondes sont exclues. |
window |
string |
Fenêtre d'agrégation. Toujours 1h. |
La réponse n'inclut ni le volume de requêtes ni le nombre brut d'erreurs.
| Code |
Description |
400 |
engine et path absents, valeur invalide, ou chemin qui ne correspond pas à engine |
401 |
Clé API absente ou invalide |
403 |
API Stats n'est pas activé pour ce compte. Contactez le support pour l'activer. |
404 |
Moteur inconnu (absent du catalogue API) |
503 |
Données de statut temporairement indisponibles |
- Ce sont les stats d'infrastructure de la plateforme, pas les stats de votre compte ou tenant. Tous les appelants authentifiés voient le même instantané.
- API Stats est activé par compte. Un HTTP 403 signifie qu'il n'est pas actif sur votre compte. Contactez le support pour l'activer.
- Fournissez au moins
engine ou path. Une requête sans les deux retourne 400.
- Utilisez Usage (
/v2/usage) pour vos crédits restants et limites de débit.
- Bloquer un job en lot lorsque le moteur est
degraded ou down
- Afficher un badge de santé à côté d'un point d'accès
- Alerter lorsque
success_rate passe sous votre seuil