account/monitors

Att skapa en bevakning och den första baslinjen är gratis. En cykel på 30 dagar debiteras så snart bevakningen blir aktiv. Priset beror på kontrollintervallet och omfattar alla kontroller som intervallet planerar inom en cykel.

Ett intervall mellan två nivåer kostar lika mycket som närmast tätare nivå: var fjärde dag kostar lika mycket som var tredje dag.

Extra kontroller sker främst när du förkortar intervallet mitt i en cykel. Varje lyckad extra kontroll kostar beloppet i tabellen.

Efter 30 dagar förnyas cykeln automatiskt till det pris som då gäller. Misslyckade kontroller kostar ingenting. När du pausar, arkiverar eller ändrar intervallet återbetalar vi ingenting.

Varje konto kan ha upp till 50 bevakningar samtidigt, en per företag. Inom 24 timmar kan du skapa upp till 50 bevakningar; arkiverade räknas också.

Priset för ett intervall får du gratis med GET /v1/account/monitoring/pricing, här för en kontroll var sjunde dag:

1. Skapa. Du anger företaget, kontrollintervallet och minst en verifierad webhook-endpoint. Bevakningen startar med statusen initializing.
2. Baslinje. Vi registrerar de senaste dagarnas signaler som kända. De levereras inte, så du får bara det som är nytt därefter.
3. Aktivera. Vi debiterar cykeln, bevakningen blir active och kontrollerar för första gången direkt.
4. Kontrollera. Därefter kontrollerar den med det valda intervallet. Varje ny signal utlöser ett meddelande per bevakning till dina webhook-endpoints.
5. Förnya. Efter varje cykel debiteras nästa automatiskt, så länge ditt saldo räcker.

Kontrollintervallet ligger mellan 1 och 30 dagar. Den exakta tidpunkten för en kontroll kan variera inom en timme. Varje kontroll ser några dagar bakåt, så att även sent publicerade anteckningar kommer fram.

En bevakning levererar Signals-ämnena i din plan: fem i varje konto, Insolvenser med Pro, Omvandlingar & M&A med Max. En webhook bär samma signal i fältet data.signal som signals gör.

För pausade bevakningar och fel förklarar status_reason varför, till exempel no_verified_endpoint eller insufficient_cycle_floor.

Alla sökvägar ligger under /v1/account. Du läser och skriver med din API-nyckel i headern x-api-key.

Varje skrivande förfrågan kräver headern Idempotency-Key, ett unikt värde per operation, helst ett UUID. Utan den svarar API:et med 428.

Om du upprepar en förfrågan med samma nyckel och samma data inom 24 timmar får du det sparade svaret tillbaka. Det har headern Idempotency-Status: replayed. Så skapar ett nätverksfel ingen andra bevakning.

Det gäller även för felsvar. För ett nytt försök efter en rättelse använder du därför en ny nyckel. Samma nyckel med andra data ger 409.

Upp till 128 tecken är tillåtna: bokstäver, siffror och . _ : -. Det första tecknet är en bokstav eller siffra. En nyckel i något annat format ger 400.

Du behöver företagets entity_id och minst en verifierad webhook-endpoint, se account/webhook-endpoints.

API:et svarar med 202: bevakningen är skapad, och baslinje och aktivering körs i bakgrunden. meta.billing.charged_credits visar att ingenting debiterades för detta.

GET /v1/account/monitors returnerar upp till 100 bevakningar under monitors, med total. Arkiverade finns inte i listan.

GET /v1/account/monitors/{id} visar dessutom den aktuella cykeln i billing_cycle och de senaste kontrollerna i recent_runs.

PATCH /v1/account/monitors/{id} ändrar kontrollintervallet. Nästa kontroll följer då med det nya intervallet, räknat från ändringen.

Den aktuella cykeln behåller sitt pris och sina inkluderade kontroller. Det nya priset gäller från nästa cykel. Ett kortare intervall kan utlösa extra kontroller i den aktuella cykeln.

POST …/{id}/pause stoppar en aktiv bevakning. Den betalda cykeln löper ut, och ingenting återbetalas.

POST …/{id}/resume återupptar en pausad bevakning eller en bevakning med fel. Vi kontrollerar webhook-endpoints, saldo och pris igen.

Inom den aktuella betalda cykeln kostar det ingenting att återuppta. Om cykeln har löpt ut startar en ny cykel nu till aktuellt pris. meta.request_credit_cost visar beloppet.

Om till exempel en verifierad webhook-endpoint saknas svarar API:et ändå med 200, men med meta.activated: false. Bevakningens status och status_reason anger orsaken.

Om priset har ändrats stannar en aktiv bevakning i slutet av cykeln med pricing_consent_required. Med resume godkänner du det nya priset.

DELETE …/{id} arkiverar bevakningen för gott. Det är slutgiltigt och ingenting återbetalas.

Fel har uppbyggnaden {"error": "…", "meta": {"message": "…"}}. I ditt program kontrollerar du värdet i error. Texten i meta.message är på engelska och kan ändras. Fel kostar ingenting.