Skip to main content
GET
Get Monitor Run

Authorizations

x-api-key
string
header
required

Path Parameters

run_id
string<uuid>
required

Response

Successful Response

A monitor run with what it delivered, as the runs' table: columns and rows, each row with change (new, or update for a company story that grew since it was delivered). stories (company monitors) and found are the older fields, kept for compatibility.

run_id
string<uuid>
required
status
string
required
role
enum<string>
default:scheduled
Available options:
scheduled,
source
error
string | null
created_at
string<date-time> | null
finished_at
string<date-time> | null
monitor_id
string<uuid> | null
name
string
default:""
kind
string
default:companies

companies or dataset.

stories
Stories · object[]

Each: story (StoryOut), company, update.

companies
Companies · object[]

What each company's refresh did: domain, news_status, created, updated, window.

more
integer
default:0

New stories beyond this run's cap, delivered by the next run.

rows
Rows · object[]

What it delivered, one row each, with change (new | update).

columns
string[]

Column order; change first.

found
integer
default:0

Dataset monitors: rows the research found (new ones and repeats).

window_from
string | null

Dataset monitors: first day this run covered.

window_to
string | null

Dataset monitors: last day this run covered.