Workbench

Estimate Workbench Provider Scraper Credits

Price a run on a connected scraper provider. CHARGES NOTHING.

Every component broken out: the scraper credits, the per-result rate, the post-scrape enrichment, the live balance and what would be left. Nothing is scraped.

get/workbench/scraper/providers/{provider}/credit-estimate

Request

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

Path parameters

provider'apify' required

Which connected scraper provider.

Query parameters

table_idstring required

The table the results would land in.

max_resultsinteger required

Ceiling on results the run would return.

preset_idstring nullable

Preset to price against. Omit for the provider's default rate.

auto_enrichboolean

Price the post-scrape enrichment too.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

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.