Skip to main content
GET
Get monitor results

Authorizations

x-api-key
string
header
required

API key for authentication.

Path Parameters

monitor_id
string<uuid>
required

Monitor identifier.

Response

Monitor results retrieved successfully

monitor_id
string<uuid>
required

Unique identifier for the monitor.

Example:

"7f3a8b2c-1e4d-4a5b-9c8d-6e7f8a9b0c1d"

reference_job
object
required
status
string
required

Current monitor status or error message if monitor creation failed.

Example:

"Done"

cron_expression
string

The cron expression for a monitor schedule parsed from the text schedule you provide.

Standard cron format (minute hour day month day-of-week).

Example:

"0 12 * * *"

timezone
string

Timezone used for schedule execution.

Example:

"UTC"

run_info
object

Execution time range for this monitor.

records
integer
default:0

Total number of records collected across all monitor jobs.

Example:

487

all_records
object[]

Aggregated records from all jobs executed by this monitor. Each record includes structured data extracted from web sources with citations.

limit
integer | null

Record limit applied to this monitor's jobs.

Example:

100

connected_datasets
object[]

Datasets used to narrow retrieval scope, each with id and name.

is_all_news_query
boolean

True when the reference job was submitted as an all-news (watchlist-generic) query.