Der Stats-Endpunkt liefert eine Infrastruktur-Gesundheitsaufnahme für eine API-Engine oder einen konkreten Pfad. Die Kennzahlen werden plattformweit über ein Stundenfenster aggregiert. Sie sind nicht Ihre Konto- oder Tenant-Nutzung. Es gibt keine Zeitreihe. Nutzen Sie den Usage-Endpunkt für das Kontokontingent Ihres Piloterr-Kontos.
Dieser Endpunkt ist kostenlos. Er verbraucht niemals Credits.
API Stats wird pro Konto aktiviert. HTTP 403 bedeutet, dass es auf Ihrem Konto nicht aktiv ist. Kontaktieren Sie den Support zur Aktivierung.
GET https://api.piloterr.com/v2/stats?engine=website
GET https://api.piloterr.com/v2/stats?path=/v2/website/crawler
Die Authentifizierung erfolgt über den x-api-key-Header.
Geben Sie mindestens engine oder path an.
| Parameter |
Typ |
Erforderlich |
Beschreibung |
engine |
string |
nein |
API-Familie zum Prüfen, zum Beispiel website. |
path |
string |
nein |
Konkreter Endpunkt zum Prüfen, zum Beispiel /v2/website/crawler. Wenn Sie auch engine übergeben, verwenden Sie einen Endpunkt dieser API. |
x-api-key |
string |
ja |
Ihr privater Piloterr-API-Schlüssel |
operational: Erfolgsrate von mindestens 99 %degraded: Erfolgsrate von 90 % bis 99 %down: Erfolgsrate unter 90 %
| Feld |
Typ |
Beschreibung |
engine |
string |
Engine-Slug aus dem Katalog (zum Beispiel website) |
path |
string | null |
Normalisierter Pfadfilter, oder null bei reiner Engine-Abfrage |
health |
string |
operational, degraded oder down für die letzte Stunde |
success_rate |
number |
Erfolgsrate der letzten Stunde. Nur HTTP 5xx gelten als Fehler. Fenster mit geringem Volumen werden geglättet. |
avg_response_time_ms |
integer |
Durchschnittliche Antwortzeit in Millisekunden. Dauern über 60 Sekunden werden ausgeschlossen. |
window |
string |
Aggregationsfenster. Immer 1h. |
Die Antwort enthält weder Anfragevolumen noch rohe Fehlerzahlen.
| Code |
Beschreibung |
400 |
engine und path fehlen, ungültiger Wert, oder Pfad passt nicht zu engine |
401 |
API-Schlüssel fehlt oder ist ungültig |
403 |
API Stats ist für dieses Konto nicht aktiviert. Kontaktieren Sie den Support zur Aktivierung. |
404 |
Unbekannte Engine (nicht im API-Katalog) |
503 |
Statusdaten vorübergehend nicht verfügbar |
- Das sind Infrastruktur-Stats der Plattform, nicht Stats Ihres Kontos oder Tenants. Jeder authentifizierte Aufrufer sieht dieselbe Aufnahme.
- API Stats wird pro Konto aktiviert. HTTP 403 bedeutet, dass es auf Ihrem Konto nicht aktiv ist. Kontaktieren Sie den Support zur Aktivierung.
- Geben Sie mindestens
engine oder path an. Anfragen ohne beides geben 400 zurück.
- Nutzen Sie Usage (
/v2/usage) für verbleibende Credits und Ratenlimits.
- Batch-Jobs stoppen, wenn eine Engine
degraded oder down ist
- Ein Gesundheitsbadge neben einem Endpunkt anzeigen
- Alarmieren, wenn
success_rate unter Ihren Schwellenwert fällt
