Workbench

Test Scraper Provider Connection

Check a token against the provider without saving it. Contacts the provider; free. Answers success: false with a reason rather than an error.

post/workbench/scraper/providers/{provider}/connection/test

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/scraper/providers/{provider}/connection/test
  • Auth: HTTP bearer

Path parameters

provider'apify' required

Which scraper provider.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

api_keystring required

Response

Successful Response

dataEnrichmentPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.