Skip to content

Submit Scrape Request

POST
/scrape/requests

Ask for a scrape. Returns a job to poll.

Scraping fetches pages from a third party and can cost credits depending on the adapter - check GET /scrape/adapters before running this in a loop.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Ask for a scrape, in plain English.

preview defaults to TRUE and that default is load-bearing: it holds the run behind a five-row sample so you can see what it will do before it does it at scale. Turning it off is what makes a run expensive.

object
adapter
Any of:
string
params
object
key
additional properties
any
preview

Hold the run behind a 5-row preview. Leave it on for a first run.

boolean
default: true
requirement
required

What to scrape, in plain English.

string
>= 3 characters <= 2000 characters
rescrape

Re-run rows that already have a result.

boolean
row_ids
Any of:
Array<integer>
seed_targets
Any of:
Array<string>
source_column
Any of:
string
staging_table_id
Any of:
string

Responses

202

Successful Response

object
data
required

An open envelope for a settings object.

Open because an ontology concept and an SSO config both grow fields as the product does, and on a settings read a dropped field reads as “not configured” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string