Run column

Path parameters

• table_idrequired

  string

  Target table ID.

• column_idrequired

  string

  Target column ID.

Body parameters

• scoperequired

  string

  Run selection mode: all, subset, row, firstN, or filtered.

• maxAdmittedRows · optional

  number

  Positive integer cap on rows admitted after eligibility and provider-readiness checks.

• rowIds · optional

  array

  Required for subset (one or more distinct valid row ObjectIds) or row (exactly one valid row ObjectId); rejected for other scopes.

• firstN · optional

  number

  Positive integer required for firstN; optional cap for filtered. Rejected for all, subset, and row.

• filters · optional

  FilterObject

  Required for filtered and must contain a non-empty filters array; rejected for other scopes.

• filters.mode · optional

  string

  Filter combination: and or or; defaults to and.

• filters.filters[].columnKeyrequired

  string

  Source table column key tested by this rule.

• filters.filters[].operatorrequired

  string

  One of equals, notEquals, contains, notContains, startsWith, endsWith, isEmpty, isNotEmpty, in, notIn, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, between, isTrue, isFalse, before, after, or dateBetween.

• filters.filters[].value · optional

  any

  Value required by value-based operators. between and dateBetween require value and value2; isEmpty, isNotEmpty, isTrue, and isFalse omit both.

• filters.filters[].value2 · optional

  any

  Second value required for between and dateBetween.

• filters.filters[].columnId · optional

  string

  Optional stable source column ID.

• filters.filters[].jsonPath · optional

  string

  Optional path within a JSON-valued column.

• unprocessedOnly · optional

  boolean

  Only queue rows whose target cell is unprocessed. Defaults to true when omitted; cannot be true together with skippedOnly.

• skippedOnly · optional

  boolean

  Select only rows currently marked skipped. When true, also send unprocessedOnly=false because that field defaults to true when omitted.

• sort · optional

  object

  Optional ordering for all, firstN, or filtered scopes. Contains column and optional direction; not supported for subset or row.

• sort.columnrequired

  string

  Non-empty source column key used to order candidate rows.

• sort.direction · optional

  string

  asc or desc; defaults to asc.

• budgetApproval · optional

  object

  Optional explicit admission budget with approved=true and positive integer maxRows and maxProviderCalls. schemaVersion defaults to research_table.run_budget_approval.v1; hard deployment caps still apply.

• budgetApproval.schemaVersion · optional

  string

  Defaults to research_table.run_budget_approval.v1; if supplied, it must equal that value.

• budgetApproval.approvedrequired

  boolean

  Must be true.

• budgetApproval.maxRowsrequired

  number

  Positive integer. Ordinary admission defaults to 10,000 rows; absolute code cap is 100,000, and deployment configuration may lower it.

• budgetApproval.maxProviderCallsrequired

  number

  Positive integer. Ordinary admission defaults to 25,000 calls; absolute code cap is 1,000,000, and deployment configuration may lower it.

• executionHints · optional

  object

  Optional execution ordering hints; accepted only with all or filtered scope.

• executionHints.priorityRowIds · optional

  array<string>

  At most 100 unique valid row ObjectIds prioritized within the selected all/filtered scope.

Definitions

{
  "mode": "and",
  "filters": [
    { "columnKey": "linkedin_url", "operator": "isNotEmpty" },
    { "columnKey": "country", "operator": "equals", "value": "United States" }
  ]
}

Errors