Skip to main content
POST
Cancel Batch

Authorizations

x-api-key
string
header
required

Path Parameters

batch_id
string<uuid>
required

Response

Successful Response

A batch (a company list too big for one run, split into runs of up to 50 companies) as one run: its status, progress, every finished part's stories and companies, and its parts.

batch_id
string<uuid>
required
title
string
required
status
string
required
progress
BatchProgress · object
required

How far a batch got.

runs
RunSummary · object[]
required
columns
string[]
required
kind
string
default:companies
query
string | null
rows
Rows · object[]
companies
Companies · object[]
window_from
string | null
window_to
string | null
list_id
string | null
keep_updated
KeepUpdatedOut · object | null

A run started with keep_updated: its monitor, once made.

monitor_id
string<uuid> | null
created_at
string<date-time> | null
finished_at
string<date-time> | null