AntiBaitby FluenceSecurity

Dokumentacja dla deweloperów

Dokumentacja

Instrukcje i dokumentacja API: jak uruchamiać analizy AntiBait w aplikacji webowej i z własnego kodu.

Dokumentacja API

Metryki statusu

Public

Pełne metryki do strony statusu: stan usług, wydajność i statystyki systemu.

Endpoint API

GET
GET/api/status/metrics

Żądanie

Uwierzytelnienie nie jest wymagane
Treść żądania nie jest potrzebna

Publiczny endpoint, nie wymaga klucza API.

Odpowiedź

{
  "status": "operational" 
    | "degraded" | "outage",
  "lastUpdated": "ISO-8601 string",
  "metrics": {...},
  "services": [...],
  "incidents": [...]
}

Przykładowa odpowiedź

cURL

curl https://antibait.io/api/status/metrics

Response

{
  "status": "operational",
  "lastUpdated": "2026-10-21T12:34:56.789Z",
  "metrics": {
    "avgResponseTime": 8420,
    "successRate": 98.7,
    "dailyAnalyses": 312,
    "totalAnalyses": 48210
  },
  "services": [
    {
      "name": "Email analysis",
      "description": "Phishing analysis of submitted emails, including the AI model",
      "status": "operational",
      "successRate": 98.7,
      "lastCheck": "2026-10-21T12:34:56.789Z"
    },
    {
      "name": "Web application and API",
      "description": "Website, sign-in and REST API",
      "status": "operational",
      "successRate": null,
      "lastCheck": "2026-10-21T12:34:56.789Z"
    },
    {
      "name": "Database",
      "description": "Accounts, history and threat intelligence data",
      "status": "operational",
      "successRate": null,
      "lastCheck": "2026-10-21T12:34:56.789Z"
    }
  ],
  "incidents": []
}

Pola odpowiedzi

statusstring

Ogólny status systemu: "operational", "degraded", "outage" lub "unknown"

lastUpdatedstring

Czas ostatniej aktualizacji metryk w formacie ISO-8601

metricsobject

Metryki wydajności i użycia:

  • avgResponseTime – Średni czas pełnej analizy w milisekundach z ostatniej godziny albo null, jeśli żadnej nie było
  • successRate – Odsetek analiz z ostatnich 24 godzin zakończonych bez błędu albo null, jeśli żadnej nie było
  • dailyAnalyses – Liczba analiz dzisiaj
  • totalAnalyses – Łączna liczba wykonanych analiz
servicesarray

Tablica komponentów usługi z ich stanem:

  • name – Nazwa usługi
  • description – Opis usługi
  • status – Aktualny status (operational, degraded, outage, unknown)
  • successRate – Zmierzony odsetek udanych analiz z ostatnich 24 godzin albo null dla komponentów bez tego pomiaru
  • lastCheck – Znacznik czasu ostatniego sprawdzenia stanu
incidentsarray

Tablica bieżących lub niedawnych incydentów (pusta, gdy wszystkie systemy działają)

Wartości statusu

operational

Działa

Wszystkie usługi działają normalnie

degraded

Zakłócenia

Niektóre usługi mają problemy lub działają wolniej

outage

Awaria

Co najmniej jedna kluczowa usługa jest niedostępna

unknown

Nieznany

Na razie nie ma czego mierzyć, np. brak analiz w ostatnich 24 godzinach

Wskazówki

Buforowanie

Odpowiedzi są buforowane przez 30 sekund, z oknem stale-while-revalidate wynoszącym 60 sekund. To dobry kompromis między aktualnością a wydajnością.

Integracja ze stroną statusu

Ten endpoint powstał z myślą o własnych stronach statusu. Zwraca wszystkie dane potrzebne do pokazania stanu usług, metryk i historii incydentów w przystępnej formie.

Śledzenie metryk

Na podstawie metryk możesz śledzić, jak zmienia się wydajność API. Odsetek udanych analiz jest liczony z żądań z ostatnich 24 godzin, a czas odpowiedzi to średnia z ostatniej godziny.

CORS włączony

Endpoint obsługuje żądania cross-origin, więc możesz go bezpiecznie wywoływać bezpośrednio z aplikacji po stronie klienta i paneli stron statusu.

Potrzebujesz pomocy z integracją API? Zespół wsparcia odpowiada w ciągu 24 godzin w dni robocze.

KontaktZobacz FAQZarządzaj kluczami API