obhutDoku

Dokumentation durchsuchen

Dokumentationsseiten durchsuchen

Nutzung und Abrechnung abrufen

Verbrauchszeitreihen, Kennzahlen und Rechnungen über die API abrufen und als CSV oder JSON exportieren.

Alle Verbrauchs- und Abrechnungsdaten eines Mandanten sind über die API abrufbar. Die Routen liegen hinter dem billing_reader-Gate — ein API-Token mit der Rolle billing, member oder admin erhält Zugriff, ein auditor-Token nicht.

Verbrauch als Zeitreihe

grain schaltet zwischen Stunden- und Tages-Buckets um; from/to grenzen den Zeitraum ein, resourceId filtert auf eine Ressource.

curl --fail-with-body \
  "https://api.obhut.io/tenants/$TENANT/usage/stats?grain=day&from=2026-06-01&to=2026-06-30" \
  --header "Authorization: Bearer $OBHUT_PAT"
RouteZweck
GET /usage/stats?grain=hour|dayZeitreihe je Bucket (Requests, Egress, Ingress, Fehler, Denies)
GET /usage/summary?grain=…Kopfkennzahlen inkl. Fehler- und Deny-Rate über den Zeitraum
GET /usage/resources?grain=…Top-20-Ressourcen nach Requests; unzugeordnet als (unmapped)

Export

Beide Formate liefern dieselben Daten; CSV wird RFC-4180-konform und gegen Formel-Injektion neutralisiert erzeugt.

curl --fail-with-body \
  "https://api.obhut.io/tenants/$TENANT/usage/export?grain=day&format=csv" \
  --header "Authorization: Bearer $OBHUT_PAT" \
  --output usage.csv

Die Antwort trägt Content-Disposition: attachment; filename="usage-<grain>.csv". Mit format=json erhalten Sie dieselbe Serie als JSON.

Rechnungen

curl --fail-with-body "https://api.obhut.io/tenants/$TENANT/invoices" \
  --header "Authorization: Bearer $OBHUT_PAT"

Eine einzelne Rechnung exportieren Sie als CSV über GET /invoices/{invoiceId}/export; die Datei heißt invoice-<periodStart>-<periodEnd>.csv. Den aktiven Plan und die Kontingente liefert GET /billing/plan.