Estimate the credit cost of a column run
Estimate the credit cost of an on-demand column run without running it. Takes the same request body as the run endpoint so estimate and run can never disagree about scope. Free runs (formula/manual columns) estimate to zero and are always sufficient.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Scope for an on-demand recompute of one formula column.
Row scope: all | errored | unfilled | first_n | cell.
all, errored, unfilled, first_n, cell Row count for scope=first_n (default 10).
1 <= x <= 10000Starting-row offset in display order for scope=first_n; omit to start at the first row.
0 <= x <= 1000000The target row for scope=cell; see also record_ids.
The target rows for scope=cell — a swept selection re-runs in one request rather than one per cell. Wins over record_id when both are sent; scope=cell requires at least one of the two.
1000Response
Successful Response
Estimated credit cost of an on-demand column run, before running it.
Free runs (formula/manual columns) estimate to zero and are always sufficient, even at a zero balance. The figure is an estimate: row counts and cell freshness can shift between estimating and running.
Whether the organization's available credits cover the estimate.
All cells the run would compute, charged or not.
Worst-case credit cost of the run (every waterfall rung runs) — the number the confirmation gate reasons about.
Always true: freshness and row counts can shift by run time.
Blended credits per charged cell (total estimate / units); 0 for free runs.
Cells that would incur a charge (0 for free runs).
Expected credit cost under the waterfall resolution curve (80% of rows answer on the first rung, 95% by the second). Equal to estimated_credits when the run has no waterfall columns. Quote THIS to the user; charging is exact per row.
Export columns this run would fire. Present so the confirmation can name the destination, the object and the action instead of only a row count. Empty for a run that writes nothing outside this table.
True when the estimate crosses the confirmation threshold — ask before spending instead of running on first click.
Rows the run would cover. This is what a scope choice is about, and what the credit estimate is derived from; cells_total also counts the dependent columns the run would recompute.