Zum Hauptinhalt springen
Die Public API (V2) ist eine REST-API zum Lesen von Anwendungsrohdaten: Metriken, Traces, Logs, Kubernetes-Metriken und Deploy-Statistiken. Sie ergänzt die GraphQL-API, die Modelle wie Apps, Incidents, Dashboards und Alerts verwaltet. Als Faustregel gilt: Verwenden Sie die REST-API zum Lesen von Daten und die GraphQL-API zur Verwaltung der Konfiguration.
Wenn Sie einen KI-Agenten oder Assistenten erstellen, stellt AppSignal MCP diese Daten direkt für Agenten bereit — möglicherweise müssen Sie diese API gar nicht selbst aufrufen.

Basis-URL

Alle Endpunkte werden unter /api/v2 auf der Domain appsignal.com bereitgestellt:

Authentifizierung

Anfragen werden mit Ihrem persönlichen API-Token authentifiziert, das entweder als Bearer-Token oder als Query-Parameter übergeben wird. Sie finden Ihr Token im Bildschirm für persönliche Einstellungen.
Ihr Token gewährt Zugriff auf dieselben Sites und Organisationen, die Sie in AppSignal sehen. Die meisten Endpunkte nehmen eine einzelne site_id entgegen. Einige Trace-Endpunkte nehmen stattdessen ein site_ids-Array entgegen, sodass sie über mehrere Sites hinweg suchen können. Die API prüft, dass Ihr Token Zugriff auf jede angeforderte Site hat, bevor Daten zurückgegeben werden. Um ein Token selbst zu überprüfen, rufen Sie GET /api/v2/auth auf. Ihre site_id ist die ID in der URL Ihrer App: https://appsignal.com/<organization>/sites/<SITE_ID>. Für Log-Abfragen benötigen Sie außerdem eine Log-Quellen-ID — siehe Site- und Quellen-IDs finden.

Ein Token überprüfen

Gibt ein JSON-Objekt mit einer message zurück, die die authentifizierte User-ID bestätigt.

Anfragen und Antworten

Die meisten Endpunkte verwenden POST mit einem JSON-Body und geben JSON zurück. Reine Lese-Lookups (etwa das Auflisten von Metriknamen) verwenden GET mit Pfadparametern. Setzen Sie bei Anfragen mit Body Content-Type: application/json. Zeitangaben sind ISO-8601-Strings. Die meisten Abfrage-Bodies nehmen einen from- und to-Zeitbereich sowie eine site_id oder ein site_ids-Array entgegen. Die Kubernetes- und Service-Edge-Endpunkte behandeln to als exklusiv.

Maschinenlesbare Referenz

/api/v2/openapi.json ist die OpenAPI-3.1-Spezifikation der API, generiert aus dem Code der API. Sie benötigt kein Token. Verwenden Sie sie, um einen API-Client zu generieren oder die API in Tools zu importieren, die OpenAPI lesen. Die Endpunkt-Referenzseiten in dieser Dokumentation werden daraus erstellt.

Fehlerantworten

Jeder Endpunkt kann diese Nicht-2xx-Antworten zurückgeben: Trace-, Such- und Log-Anfragen sind auf wenige gleichzeitige Anfragen pro User begrenzt. Bei den Trace-Listen-Endpunkten kann ein 429 auch eine suggestion enthalten: eine schnellere Formulierung für den Filter der Anfrage. Siehe Traces auflisten.

Fehler-Envelope

Jede 400-Antwort verwendet denselben Envelope, sodass Sie sie an einer Stelle behandeln können:
  • error: ein stabiles, maschinenlesbares Slug. Verzweigen Sie in Ihrem Code darauf.
  • message: eine menschenlesbare Nachricht, sicher zur Anzeige.
  • details: optionale Daten, deren Form von error abhängt.
Einige Referenzseiten listen die eigenen Slugs eines Endpunkts auf. Zum Beispiel gibt das Paginieren einer Metrikliste pagination_invalid_per_page für ein per_page außerhalb des gültigen Bereichs zurück. Siehe Eine Liste paginieren.

Endpunkte

Metriken

Wie Sie sie verwenden, erfahren Sie unter Metriken abfragen.

Tracing

Wie Sie sie verwenden, erfahren Sie unter Traces abfragen.

Logs

Die Abfragesprache finden Sie unter Logs abfragen. Die Abfragesyntax finden Sie unter Traces durchsuchen.

Ereignisse

Wie Sie ihn verwenden, erfahren Sie unter Top-Ereignisse nach Gruppe.

Kubernetes

Deploys

Check-ins

Gespeicherte Visuals

Endpunkte für gespeicherte Visuals erfordern keine Authentifizierung.

System