account/monitors

Oprettelse af en monitor og den første baseline er gratis. En cyklus på 30 dage afregnes, så snart monitoren bliver aktiv. Prisen afhænger af tjekintervallet og dækker alle tjek, som intervallet planlægger inden for én cyklus.

Et interval mellem to trin koster lige så meget som det næste hyppigere trin: hver fjerde dag koster lige så meget som hver tredje dag.

Ekstra tjek sker primært, når du forkorter intervallet midt i en cyklus. Hvert vellykket ekstra tjek koster beløbet i tabellen.

Efter 30 dage fornyes cyklussen automatisk til den pris, der gælder på det tidspunkt. Mislykkede tjek koster intet. Når du sætter på pause, arkiverer eller ændrer intervallet, refunderer vi intet.

Hver konto kan have op til 50 monitors på samme tid, én pr. virksomhed. Inden for 24 timer kan du oprette op til 50 monitors; arkiverede tæller med.

Prisen for et interval får du gratis med GET /v1/account/monitoring/pricing, her for et tjek hver syvende dag:

1. Opret. Du angiver virksomheden, tjekintervallet og mindst ét verificeret webhook-endpoint. Monitoren starter med status initializing.
2. Baseline. Vi registrerer de seneste dages signaler som kendte. De leveres ikke, så du kun får det, der er nyt derefter.
3. Aktivér. Vi afregner cyklussen, monitoren bliver active og tjekker første gang med det samme.
4. Tjek. Derefter tjekker den med det valgte interval. Hvert nyt signal udløser én besked pr. monitor til dine webhook-endpoints.
5. Forny. Efter hver cyklus afregnes den næste automatisk, så længe din saldo dækker den.

Tjekintervallet ligger mellem 1 og 30 dage. Det præcise tidspunkt for et tjek kan variere inden for en time. Hvert tjek ser nogle dage tilbage, så sent offentliggjorte indførsler alligevel kommer med.

En monitor leverer Signals-emnerne i dit abonnement: fem i alle konti, Insolvenser med Pro, Omdannelser & M&A med Max. En webhook bærer det samme signal i feltet data.signal som signals.

For monitors på pause og fejl forklarer status_reason hvorfor, f.eks. no_verified_endpoint eller insufficient_cycle_floor.

Alle stier ligger under /v1/account. Du læser og skriver med din API-nøgle i headeren x-api-key.

Hver skriveforespørgsel kræver headeren Idempotency-Key, en entydig værdi pr. handling, helst et UUID. Uden den svarer API’et med 428.

Gentager du en forespørgsel med samme nøgle og samme data inden for 24 timer, får du det gemte svar tilbage. Det har headeren Idempotency-Status: replayed. Sådan opretter en netværksfejl ikke en monitor nummer to.

Det gælder også fejlsvar. Til et nyt forsøg efter en rettelse bruger du derfor en ny nøgle. Den samme nøgle med andre data returnerer 409.

Op til 128 tegn er tilladt: bogstaver, cifre og . _ : -. Det første tegn er et bogstav eller et ciffer. En nøgle i ethvert andet format returnerer 400.

Du skal bruge virksomhedens entity_id og mindst ét verificeret webhook-endpoint, se account/webhook-endpoints.

API’et svarer med 202: monitoren er oprettet, og baseline og aktivering kører i baggrunden. meta.billing.charged_credits viser, at der ikke er afregnet noget for det.

GET /v1/account/monitors returnerer op til 100 monitors under monitors, med total. Arkiverede er ikke med i listen.

GET /v1/account/monitors/{id} viser desuden den aktuelle cyklus i billing_cycle og de seneste tjek i recent_runs.

PATCH /v1/account/monitors/{id} ændrer tjekintervallet. Det næste tjek følger så med det nye interval, regnet fra ændringen.

Den aktuelle cyklus beholder sin pris og sine inkluderede tjek. Den nye pris gælder fra næste cyklus. Et kortere interval kan udløse ekstra tjek i den aktuelle cyklus.

POST …/{id}/pause stopper en aktiv monitor. Den betalte cyklus løber ud, og intet refunderes.

POST …/{id}/resume genoptager en monitor på pause eller en monitor med fejl. Vi tjekker webhook-endpoints, saldo og pris igen.

Inden for den aktuelle betalte cyklus koster genoptagelse intet. Er cyklussen udløbet, starter en ny cyklus nu til den aktuelle pris. meta.request_credit_cost viser beløbet.

Mangler der f.eks. et verificeret webhook-endpoint, svarer API’et stadig med 200, men med meta.activated: false. Monitorens status og status_reason angiver årsagen.

Er prisen ændret, stopper en aktiv monitor ved cyklussens udløb med pricing_consent_required. Med resume accepterer du den nye pris.

DELETE …/{id} arkiverer monitoren for altid. Det er endeligt og refunderer intet.

Fejl har opbygningen {"error": "…", "meta": {"message": "…"}}. Tjek i dit program værdien af error. Teksten i meta.message er på engelsk og kan ændre sig. Fejl koster intet.