account/monitors

Η δημιουργία ενός monitor και η πρώτη αρχική κατάσταση είναι δωρεάν. Ένας κύκλος 30 ημερών χρεώνεται μόλις το monitor ενεργοποιηθεί. Η τιμή εξαρτάται από τη συχνότητα ελέγχου και καλύπτει όλους τους ελέγχους που προγραμματίζει η συχνότητα μέσα σε έναν κύκλο.

Μια συχνότητα ανάμεσα σε δύο βαθμίδες κοστίζει όσο η επόμενη συχνότερη βαθμίδα: κάθε τέσσερις ημέρες κοστίζει όσο κάθε τρεις ημέρες.

Επιπλέον έλεγχοι γίνονται κυρίως όταν συντομεύεις τη συχνότητα στη μέση ενός κύκλου. Κάθε επιτυχής επιπλέον έλεγχος κοστίζει το ποσό του πίνακα.

Μετά από 30 ημέρες ο κύκλος ανανεώνεται αυτόματα με την τιμή που ισχύει τότε. Οι αποτυχημένοι έλεγχοι δεν κοστίζουν τίποτα. Όταν κάνεις παύση, αρχειοθέτηση ή αλλάζεις τη συχνότητα, δεν επιστρέφουμε τίποτα.

Κάθε λογαριασμός μπορεί να έχει έως 50 monitors ταυτόχρονα, ένα ανά εταιρεία. Μέσα σε 24 ώρες μπορείς να δημιουργήσεις έως 50 monitors· μετρούν και τα αρχειοθετημένα.

Την τιμή μιας συχνότητας τη λαμβάνεις δωρεάν με GET /v1/account/monitoring/pricing, εδώ για έλεγχο κάθε επτά ημέρες:

1. Δημιουργία. Ορίζεις την εταιρεία, τη συχνότητα ελέγχου και τουλάχιστον ένα επαληθευμένο endpoint webhook. Το monitor ξεκινά με την κατάσταση initializing.
2. Αρχική κατάσταση. Καταγράφουμε τα signals των τελευταίων λίγων ημερών ως γνωστά. Δεν παραδίδονται, οπότε λαμβάνεις μόνο ό,τι νέο προκύψει μετά.
3. Ενεργοποίηση. Χρεώνουμε τον κύκλο, το monitor γίνεται active και ελέγχει αμέσως για πρώτη φορά.
4. Έλεγχος. Στη συνέχεια ελέγχει με τη συχνότητα που επέλεξες. Κάθε νέο signal προκαλεί ένα μήνυμα ανά monitor στα endpoints webhook σου.
5. Ανανέωση. Μετά από κάθε κύκλο χρεώνεται αυτόματα ο επόμενος, εφόσον το υπόλοιπό σου τον καλύπτει.

Η συχνότητα ελέγχου είναι μεταξύ 1 και 30 ημερών. Η ακριβής ώρα ενός ελέγχου μπορεί να διαφέρει μέσα σε μία ώρα. Κάθε έλεγχος κοιτάζει λίγες ημέρες πίσω, ώστε να φτάνουν και εγγραφές που δημοσιεύτηκαν καθυστερημένα.

Ένα monitor παραδίδει τα θέματα Signals του πλάνου σου: πέντε σε κάθε λογαριασμό, Αφερεγγυότητες με Pro, Μετασχηματισμοί & M&A με Max. Ένα webhook μεταφέρει στο πεδίο data.signal το ίδιο signal με το signals.

Για monitors σε παύση και σφάλματα, το status_reason εξηγεί το γιατί, για παράδειγμα no_verified_endpoint ή insufficient_cycle_floor.

Όλες οι διαδρομές βρίσκονται στο /v1/account. Διαβάζεις και γράφεις με το κλειδί API σου στο header x-api-key.

Κάθε αίτημα εγγραφής χρειάζεται το header Idempotency-Key, μια μοναδική τιμή ανά λειτουργία, ιδανικά ένα UUID. Χωρίς αυτό το API απαντά με 428.

Αν επαναλάβεις ένα αίτημα με το ίδιο κλειδί και τα ίδια δεδομένα μέσα σε 24 ώρες, λαμβάνεις πίσω την αποθηκευμένη απάντηση. Φέρει το header Idempotency-Status: replayed. Έτσι ένα σφάλμα δικτύου δεν δημιουργεί δεύτερο monitor.

Αυτό ισχύει και για απαντήσεις σφάλματος. Γι’ αυτό για μια νέα προσπάθεια μετά από διόρθωση, χρησιμοποίησε νέο κλειδί. Το ίδιο κλειδί με διαφορετικά δεδομένα επιστρέφει 409.

Επιτρέπονται έως 128 χαρακτήρες: γράμματα, ψηφία και . _ : -. Ο πρώτος χαρακτήρας είναι γράμμα ή ψηφίο. Ένα κλειδί σε οποιαδήποτε άλλη μορφή επιστρέφει 400.

Χρειάζεσαι το entity_id της εταιρείας και τουλάχιστον ένα επαληθευμένο endpoint webhook, βλ. account/webhook-endpoints.

Το API απαντά με 202: το monitor δημιουργήθηκε, και η αρχική κατάσταση και η ενεργοποίηση εκτελούνται στο παρασκήνιο. Το meta.billing.charged_credits δείχνει ότι δεν χρεώθηκε τίποτα γι’ αυτό.

Το GET /v1/account/monitors επιστρέφει έως 100 monitors στο monitors, με total. Τα αρχειοθετημένα δεν περιλαμβάνονται στη λίστα.

Το GET /v1/account/monitors/{id} δείχνει επιπλέον τον τρέχοντα κύκλο στο billing_cycle και τους πιο πρόσφατους ελέγχους στο recent_runs.

Το PATCH /v1/account/monitors/{id} αλλάζει τη συχνότητα ελέγχου. Ο επόμενος έλεγχος ακολουθεί τότε με τη νέα συχνότητα, μετρώντας από την αλλαγή.

Ο τρέχων κύκλος διατηρεί την τιμή του και τους ελέγχους που περιλαμβάνει. Η νέα τιμή ισχύει από τον επόμενο κύκλο. Μια συντομότερη συχνότητα μπορεί να προκαλέσει επιπλέον ελέγχους στον τρέχοντα κύκλο.

Το POST …/{id}/pause σταματά ένα ενεργό monitor. Ο πληρωμένος κύκλος συνεχίζει μέχρι να λήξει, και δεν επιστρέφεται τίποτα.

Το POST …/{id}/resume συνεχίζει ένα monitor σε παύση ή ένα monitor με σφάλμα. Ελέγχουμε ξανά endpoints webhook, υπόλοιπο και τιμή.

Μέσα στον τρέχοντα πληρωμένο κύκλο, η συνέχιση δεν κοστίζει τίποτα. Αν ο κύκλος έχει λήξει, ξεκινά τώρα νέος κύκλος με την τρέχουσα τιμή. Το meta.request_credit_cost δείχνει το ποσό.

Αν, για παράδειγμα, λείπει ένα επαληθευμένο endpoint webhook, το API απαντά παρ’ όλα αυτά με 200, αλλά με meta.activated: false. Η κατάσταση του monitor και το status_reason δίνουν την αιτία.

Αν η τιμή έχει αλλάξει, ένα ενεργό monitor σταματά στο τέλος του κύκλου με pricing_consent_required. Με το resume συμφωνείς με τη νέα τιμή.

Το DELETE …/{id} αρχειοθετεί οριστικά το monitor. Αυτό είναι τελικό και δεν επιστρέφει τίποτα.

Τα σφάλματα έχουν τη δομή {"error": "…", "meta": {"message": "…"}}. Στο πρόγραμμά σου, έλεγχε την τιμή του error. Το κείμενο στο meta.message είναι στα αγγλικά και μπορεί να αλλάξει. Τα σφάλματα δεν κοστίζουν τίποτα.