Skip to content

Save Scraper Provider Connection

PUT
/workbench/scraper/providers/{provider}/connection

Connect, or replace, your provider account token. Free.

The token is sealed at rest and never returned. Check it first with POST .../connection/test; saving does not.

Authorizations

Parameters

Path Parameters

provider
required

Which scraper provider.

string

Which scraper provider.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Connect your own scraper provider account. The token is write-only.

object
api_key
required

Your provider API token. Never returned.

string
>= 1 characters
configuration
object
key
additional properties
any

Responses

200

Successful Response

object
data
required

One enrichment object, open-shaped.

Open on purpose: a workbench column set is defined by the CUSTOMER at runtime, and the enrichment result shapes grow with every provider added. Pinning them would drop whatever a provider returned that this contract had not caught up on, which on an enrichment surface is the data the customer paid for.

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