Referenz: Kennzahlen (/v1/metrics)

Ausgewertete Kennzahlen samt Berechnungsangabe. Befragungsdaten nur aggregiert. Alle Felder, Filter, Rechte und Fehler dieser Ressource.

Für wen

Entwicklerinnen und Entwickler, die elyph anbinden.

Voraussetzungen

Schlüssel mit dem Recht metrics:read Grundlagen aus „Erste Anfrage an die elyph API“

Schritt für Schritt

1
Liste abrufen
GET https://api.elyph.io/v1/metrics liefert die Objekte des Mandanten, sortiert nach letzter Änderung. Erforderliches Recht: metrics:read.
curl
curl -sS "https://api.elyph.io/v1/metrics?limit=50&metric=actions_overdue" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Antwort lesen

Die Antwort enthält `data` mit den Objekten, `page.next` als Fortsetzungsmarke und `rate` mit dem verbleibenden Abfragekontingent.

Antwort

{
  "data": [
    {
      "metric": "actions_overdue",
      "value": 7,
      "captured_on": "2026-01-31",
      "calculation": "Tageswert der Kennzahl actions_overdue, berechnet aus den Mandantendaten zum Stichtag.",
      "updated_at": "2026-01-31T02:15:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 50
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

3
Filter setzen
Verfügbare Filter: `metric` — Schlüssel der Kennzahl, etwa `actions_overdue`. `since` — Nur Werte ab diesem Stichtag (Datum). `limit` — Anzahl der Objekte je Seite, 1 bis 200. Standard 50. `page` — Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl. Mehrere Filter werden mit `&` verbunden und wirken zusammen.
4
Einzelnes Objekt holen
Der Pfad /v1/metrics/{Kennung} liefert genau ein Objekt. Kennung ist `metric` + `captured_on`. Unbekannte Kennungen ergeben 404 `not_found`.
curl
curl -sS "https://api.elyph.io/v1/metrics/{kennung}" \ -H "Authorization: Bearer $ELYPH_API_KEY"

Felder der Antwort

Feld	Typ	Bedeutung
metric	string	Schlüssel der Kennzahl, etwa `actions_overdue`.
value	number	Wert zum Stichtag.
captured_on	string (Datum)	Stichtag der Messung.
calculation	string	Klartextangabe, wie der Wert entstanden ist.
updated_at	string (ISO 8601)	Letzte Änderung. Sortierfeld der Liste und Grundlage für `updated_since`.

Filter

Parameter	Beschreibung	Beispiel
metric	Schlüssel der Kennzahl, etwa `actions_overdue`.	metric=actions_overdue
since	Nur Werte ab diesem Stichtag (Datum).	since=2026-01-01
limit	Anzahl der Objekte je Seite, 1 bis 200. Standard 50.	limit=100
page	Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.	page=eyJ1IjoiMjAy…

Rechte und Methoden

Angabe	Wert
Pfad	/v1/metrics
Methoden	GET
Rechte	metrics:read
Kennung	`metric` + `captured_on`

API-Konsole

Anfrage zusammenstellen, Code kopieren und — angemeldet und mit eigenem Schlüssel — wirklich ausführen. Die Konsole führt ausschließlich lesende Aufrufe aus.

Ressource

Adresse

GET https://api.elyph.io/v1/metrics?limit=10

metric

Schlüssel der Kennzahl, etwa `actions_overdue`.

since

Nur Werte ab diesem Stichtag (Datum).

limit

Anzahl der Objekte je Seite, 1 bis 200. Standard 50.

page

Fortsetzungsmarke aus `page.next` der vorherigen Antwort. Keine Seitenzahl.

curl

curl -sS "https://api.elyph.io/v1/metrics?limit=10" \
  -H "Authorization: Bearer $ELYPH_API_KEY"

Echttest

Nach der Anmeldung führen Sie dieselbe Anfrage hier mit Ihrem eigenen Schlüssel aus. So sieht eine echte Antwort aus:

Beispielantwort

{
  "data": [
    {
      "metric": "actions_overdue",
      "value": 7,
      "captured_on": "2026-01-31",
      "calculation": "Tageswert der Kennzahl actions_overdue, berechnet aus den Mandantendaten zum Stichtag.",
      "updated_at": "2026-01-31T02:15:00Z"
    }
  ],
  "page": {
    "next": null,
    "limit": 10
  },
  "rate": {
    "limit": 120,
    "remaining": 118,
    "reset_at": "2026-02-01T10:31:00Z"
  }
}

Ergebnis

Sie können kennzahlen zuverlässig lesen, filtern und mit Ihrem System abgleichen.

Häufige Stolpersteine

Interne UUIDs statt der fachlichen Kennung speichern: Verwenden Sie `metric` + `captured_on` als stabile Verknüpfung.
Alle Daten bei jedem Lauf neu laden: Mit `updated_since` holen Sie nur Änderungen.

Hintergrund

Die Ressource ist streng auf den Mandanten des Schlüssels begrenzt. Ist der Zugang auf Standorte eingeschränkt, liefert die Liste nur Objekte dieser Standorte. Jede Anfrage wird mit Zeitpunkt, Pfad, Status und Trefferzahl protokolliert und ist in der Verwaltung einsehbar.