Zum Hauptinhalt springen
Lesen Sie Metrikdaten mit der Public API (V2). Holen Sie eine Zeitreihe für Graphen, eine aggregierte Liste für Tabellen oder ermitteln Sie, welche Metriken und Tags eine Site bietet. Alle Endpunkte authentifizieren sich mit Ihrem persönlichen API-Token und sind auf eine einzelne site_id begrenzt.

Eine Zeitreihe abfragen

Dieser Endpunkt gibt eine oder mehrere Serien von Datenpunkten über einen Zeitbereich zurück. Verwenden Sie ihn zum Zeichnen von Graphen.

Request-Body

Jeder select-Eintrag nimmt einen name einer Metrik, ein tags-Objekt zum Filtern (Werte können * als Platzhalter verwenden), ein field (siehe Felder), eine optionale aggregation (siehe Aggregationen) und draw_null_as_zero (wenn true, werden fehlende Punkte mit 0 aufgefüllt) entgegen.

Antwort

Gibt eine Timeseries mit der abgefragten resolution, from, to und einem series-Array zurück. Jede Serie hat eine id, den Metrik-name, ihre tags, das field, das sie repräsentiert, min und max über den Bereich sowie ein data-Array von Punkten. Jeder Punkt hat einen timestamp und einen numerischen value.

Eine Liste abfragen

Dieser Endpunkt gibt aggregierte Metrikwerte gruppiert in Zeilen zurück. Verwenden Sie ihn, um Tabellen zu erstellen.

Request-Body

Ein ListSelector ist wie ein Timeseries-Selector mit einer zusätzlichen id, die den Wert des Selectors im data-Objekt jeder Zeile benennt. group_by-Einträge sind Name (nach Metrikname gruppieren) oder Tag (nach Tag-Wert gruppieren).

Antwort

Gibt eine List mit der abgefragten resolution, from, to und einem rows-Array zurück. Jede Zeile hat eine id, ein group-Objekt mit den Tag-Werten, die sie definieren, und ein data-Objekt mit aggregierten Werten, indiziert nach Selector-id (zum Beispiel { "mean": 42.5 }).

Metriknamen auflisten

Gibt jeden für eine Site verfügbaren Metriknamen zurück.
Gibt ein Array von Strings zurück.

Typ und Tags einer Metrik abrufen

Gibt den Typ einer Metrik und die Tag-Kombinationen zurück, mit denen sie abgefragt werden kann.
Gibt einen metric_type (gauge, counter oder measurement) und available_tags zurück, ein Array, dessen Einträge jeweils eine gültige Kombination von Tag-Schlüsseln sind.

Referenz

Felder

Das field wählt aus, welche Messung aus einer Metrik abgerufen wird: Weitere Typreferenzen finden Sie in der AppSignal V2 API-Dokumentation.

Aggregationen

Die aggregation kombiniert mehrere Werte innerhalb eines Zeitfensters: sum, avg, min, max, first oder last.

Auflösungen

resolution akzeptiert MINUTELY, FIVE_MINUTELY, TEN_MINUTELY, FIFTEEN_MINUTELY, HOURLY oder DAILY.