Skip to main content
POST
Preview a provider order

Authorizations

X-API-Key
string
header
required

Path Parameters

action_key
string
required
Required string length: 1 - 128

Body

application/json

A provider choice to preview: what order the rows would walk and what a row costs.

providers
WaterfallProviders · object | null

The column's settings.providers (preset, steps), as it would be saved. null is Recommended.

second_check
boolean
default:false

The column's settings.second_check, as it would be saved: a column whose second check is on may be charged one more lookup on a row, so it doubles the most a row costs. Ignored by an enrichment that offers no second check.

Response

Successful Response

The order a choice resolves to for this workspace, and what a row costs at most.

max_credits_per_row
number
required

The most a row costs: the dearest step of the order, doubled when the column's second check is on, as the column editor and the run's quote price it.

True when the workspace is on no paid plan, so the choice is not used yet.

steps
ResolvedProviderStepSchema · object[]
required