account/monitors

Anlegen und die erste Bestandsaufnahme sind kostenlos. Berechnet wird ein Zyklus von 30 Tagen, sobald der Monitor aktiv wird. Der Preis hängt vom Prüfrhythmus ab und deckt alle Prüfungen ab, die der Rhythmus in einem Zyklus vorsieht.

Ein Rhythmus zwischen zwei Stufen kostet so viel wie die nächsthäufigere Stufe: alle vier Tage also so viel wie alle drei Tage.

Zusätzliche Prüfungen entstehen vor allem, wenn du den Rhythmus mitten im Zyklus verkürzt. Jede erfolgreiche zusätzliche Prüfung kostet den Betrag in der Tabelle.

Nach 30 Tagen verlängert sich der Zyklus automatisch zum dann gültigen Preis. Fehlgeschlagene Prüfungen kosten nichts. Wenn du pausierst, archivierst oder den Rhythmus änderst, erstatten wir nichts.

Pro Konto sind bis zu 50 Monitore gleichzeitig möglich, pro Firma einer. In 24 Stunden kannst du bis zu 50 Monitore anlegen, archivierte zählen mit.

Den Preis eines Rhythmus fragst du kostenlos mit GET /v1/account/monitoring/pricing ab, hier für eine Prüfung alle sieben Tage:

1. Anlegen. Du nennst die Firma, den Prüfrhythmus und mindestens einen verifizierten Webhook-Endpoint. Der Monitor startet mit dem Status initializing.
2. Bestandsaufnahme. Wir merken uns die Signals der letzten Tage als bekannt. Sie werden nicht zugestellt, du bekommst also nur, was danach neu dazukommt.
3. Aktivieren. Wir buchen den Zyklus, der Monitor wird active und prüft sofort zum ersten Mal.
4. Prüfen. Danach prüft er im gewählten Rhythmus. Jedes neue Signal löst pro Monitor eine Nachricht an deine Webhook-Endpoints aus.
5. Verlängern. Nach jedem Zyklus bucht sich der nächste automatisch, solange dein Guthaben reicht.

Der Prüfrhythmus liegt zwischen 1 und 30 Tagen. Die genaue Uhrzeit einer Prüfung kann innerhalb einer Stunde schwanken. Jede Prüfung schaut ein paar Tage zurück, damit auch spät veröffentlichte Einträge ankommen.

Ein Monitor liefert die Signals-Themen deines Plans: fünf in jedem Konto, Insolvenzen ab Pro, Umwandlungen & M&A mit Max. Ein Webhook enthält im Feld data.signal dasselbe Signal wie signals.

Bei pausierten Monitoren und Fehlern erklärt status_reason den Grund, etwa no_verified_endpoint oder insufficient_cycle_floor.

Alle Pfade liegen unter /v1/account. Lesen und Schreiben geht mit deinem API-Schlüssel im Header x-api-key.

Jede schreibende Anfrage braucht den Header Idempotency-Key, einen eindeutigen Wert pro Vorgang, am besten eine UUID. Ohne ihn antwortet die API mit 428.

Wiederholst du eine Anfrage mit demselben Key und denselben Daten, bekommst du innerhalb von 24 Stunden die gespeicherte Antwort zurück. Sie trägt den Header Idempotency-Status: replayed. So legt ein Netzwerkfehler keinen zweiten Monitor an.

Das gilt auch für Fehlerantworten. Für einen neuen Versuch nach einer Korrektur nimmst du deshalb einen neuen Key. Derselbe Key mit anderen Daten ergibt 409.

Erlaubt sind bis zu 128 Zeichen aus Buchstaben, Ziffern und . _ : -. Das erste Zeichen ist ein Buchstabe oder eine Ziffer. Ein Key in anderem Format ergibt 400.

Du brauchst die entity_id der Firma und mindestens einen verifizierten Webhook-Endpoint, siehe account/webhook-endpoints.

Die API antwortet mit 202: Der Monitor ist angelegt, Bestandsaufnahme und Aktivierung laufen im Hintergrund. meta.billing.charged_credits zeigt, dass dabei nichts berechnet wurde.

GET /v1/account/monitors liefert bis zu 100 Monitore unter monitors, mit total. Archivierte fehlen in der Liste.

GET /v1/account/monitors/{id} zeigt dazu den laufenden Zyklus in billing_cycle und die letzten Prüfungen in recent_runs.

PATCH /v1/account/monitors/{id} ändert den Prüfrhythmus. Die nächste Prüfung folgt dann im neuen Abstand, gerechnet ab der Änderung.

Der laufende Zyklus behält Preis und enthaltene Prüfungen. Der neue Preis gilt ab dem nächsten Zyklus. Ein kürzerer Rhythmus kann im laufenden Zyklus zusätzliche Prüfungen auslösen.

POST …/{id}/pause hält einen aktiven Monitor an. Der bezahlte Zyklus läuft weiter ab, erstattet wird nichts.

POST …/{id}/resume setzt einen pausierten Monitor oder einen Monitor mit Fehler fort. Dabei prüfen wir erneut Webhook-Endpoints, Guthaben und Preis.

Im laufenden bezahlten Zyklus kostet das Fortsetzen nichts. Ist er abgelaufen, beginnt ab jetzt ein neuer Zyklus zum aktuellen Preis. meta.request_credit_cost zeigt den Betrag.

Fehlt etwa ein verifizierter Webhook-Endpoint, antwortet die API trotzdem mit 200, aber mit meta.activated: false. Status und status_reason des Monitors nennen den Grund.

Hat sich der Preis geändert, hält ein aktiver Monitor zum Zyklusende mit pricing_consent_required an. Mit resume stimmst du dem neuen Preis zu.

DELETE …/{id} archiviert den Monitor dauerhaft. Der Vorgang ist endgültig und erstattet nichts.

Fehler haben den Aufbau {"error": "…", "meta": {"message": "…"}}. Prüfe im Programm den Wert von error. Der Text in meta.message ist auf Englisch und kann sich ändern. Fehler kosten nichts.