Smart columns

Poll a smart-column run

Progress of one smart-column run: the jobId returned by create, rerun, or a prompt edit. status moves from pending to processing and ends as completed, partially_completed (some rows failed), failed or cancelled (superseded by a newer run or a prompt edit). processedRows, successfulRows and failedRows count against totalRows, and creditsUsed is what the run has consumed so far at creditsPerRow. mode says why the run exists: initial for the column's first run, all or new_only for a rerun, refresh for the re-run a prompt edit starts, single_row for an automation. Poll every few seconds until the status is terminal; the values are then on GET /business/lists/{listId}/rows under columnValues[columnId]. Free to call.

Errors:

  • 404 LIST_NOT_FOUND — No list with that id belongs to you.
  • 404 JOB_NOT_FOUND — No run with that jobId exists on this list.
  • 422 VALIDATION_FAILED — The path, query or body failed validation; param names the offending field and message says why.
  • 429 RATE_LIMITED — More than 120 requests per minute or 10,000 per day on the lists bucket, which every /business/lists endpoint shares; retry after Retry-After.
  • 500 UNEXPECTED_ERROR — The request could not be completed; quote request_id to support.

Requires one of the following token scopes: lists.

get/business/lists/{listId}/smart-columns/{jobId}/status

Request

  • Base URL: https://api.tryfuse.ai/api/v1
  • URL: https://api.tryfuse.ai/api/v1/business/lists/{listId}/smart-columns/{jobId}/status
  • Auth: HTTP basic

Path parameters

listIdstring required

Id of the list that owns the smart column.

jobIdstring required

Id of the smart-column run to poll, as returned in jobId by the create or rerun call that started it.

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.