Skip to main content
POST
Create Monitor

Authorizations

Authorization
string
header
required

Use Authorization: Bearer YOUR_API_KEY

Headers

Idempotency-Key
string

Optional client-chosen key for this request (any string up to 255 characters, e.g. a UUID). Every Croma operation is an idempotent lookup: repeating a request with the same body returns the same result and creates nothing, so retrying after a timeout or network failure is always safe. The key is echoed back in the Idempotency-Key response header so you can correlate a retry with its first attempt. Each attempt that reaches the API counts against the rate limit.

Maximum string length: 255
Example:

"0f8e9a42-6b7c-4d1e-9a3f-2c5d7e8f9a0b"

Body

application/json
name
string
required
Required string length: 1 - 120
Example:

"Contrato AD9-111"

endpoint
string
required

The dataset endpoint to watch, by path or catalog id. Only endpoints with monitorable: true in /catalog are accepted.

Example:

"/co/anm/notices-search/v1"

recipients
string<email>[]
required

Up to three addresses that receive the results.

Required array length: 1 - 3 elements
query
object

The request body the monitor sends to the endpoint, validated exactly as a direct request would be. page and per_page are not allowed.

Example:
schedule
object

When the monitor runs. source (the default) runs right after the dataset's own refresh completes; hourly, daily and weekly run on the clock, never faster than the source refreshes.

notify
enum<string>
default:always

always sends an email on every run, including one that found nothing new; on_new only when there is something to report.

Available options:
always,
on_new
language
enum<string>
default:es

Language of the emails.

Available options:
es,
en
relevance
string | null

Optional instruction, in plain language, that filters new results by relevance before they are sent (e.g. "solo avisos sobre suspensión o caducidad del título"). Results the filter discards stay available under GET /monitors/{id}/matches?relevant=false.

Maximum string length: 500

Response

The monitor, with its compiled schedule and next run.

data
object
required