Skip to main content
POST
Estimate a Monitor
Takes the same body as Create a Monitor, checks it the same way, and returns the cost. Free.
The same source checked daily is 30 credits a month. usesAi is true when a source extracts with AI, which adds token credits on top. A goal adds a little AI only on checks where something changed, and isn’t part of the estimate.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

Defaults to the first source's label.

sources
object[]
Required array length: 1 - 10 elements
schedule
object

Your plan sets the shortest interval: daily on Free, hourly on Starter, every 15 minutes on Builder, every 5 minutes on Pro.

alertOn
enum<string>

What counts as a change. Default page when every source is a URL list, otherwise new.

Available options:
new,
changed,
removed,
page,
every
watchFields
string[]

alertOn changed: only these fields count. Empty means every field.

Maximum array length: 20
rule
object | null

Only alert about items where this is true, for example { "field": "price", "op": "drops_by_pct", "value": 10 }.

goal
string | null

Plain-language goal. When something changed, AI decides whether it matches before alerting, and says why.

Maximum string length: 1000
notify
object
checkNow
boolean
default:true

Create only: run the first check straight away. It records the starting point and doesn't alert.

Response

The estimate.

status
enum<string>
Available options:
success
creditsPerCheck
number
checksPerMonth
integer
creditsPerMonth
number
usesAi
boolean

true when a source extracts with AI, which adds token credits.