Workbench

Discover Workbench Fields

List the JSON paths present inside a raw column. FREE.

Despite the name this calls no provider and spends nothing - it samples rows the customer already imported and reports the shapes it found. Call it before columns/extract to learn what field_path values exist.

post/workbench/tables/{table_id}/discover-fields

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/workbench/tables/{table_id}/discover-fields
  • Auth: HTTP bearer

Path parameters

table_idstring required

Workbench table id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

source_column_idinteger required

The raw JSON column to scan.

sample_sizeinteger

Rows to sample.

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.