Skip to main content
Query job processing status by publisher token, pipeline token, or pipeline name, or clear all ingestion history.

Get Status by Publisher Token

Use this to watch every ingestion job a single caller submitted. Tap runs set a publisherToken on every job they spawn, so one query covers:
  • Structured taps → the single job that ingested the fetched records.
  • Document taps → every per-document job (one per file in a run).
Parameters: Example:
Response: 200 OK — status entries from every job whose publisherToken matches, sorted oldest-first. Each job has its own pipelineToken; group rows by pipelineToken to see one job at a time. If both publishertoken and pipelinetoken are supplied, publishertoken wins.

Get Status by Pipeline Token

Parameters: Example:
Response: 200 OK - an array of status entries, one per processing stage:

Get Status by Pipeline Name

Parameters: Example:
Response: 200 OK - an array of job summaries:

Rollup Response

Add &withrollup=true to a publishertoken or pipelinetoken query and the response is wrapped:
rollup.allDone flips to true when every job has reached a terminal state. rollup.status is the aggregate outcome — success, warning, error, or processing. Per-job status values are success, warning, error, processing, or timed_out (no terminal event within 8 hours of the first event). When a job’s status is error, lastError carries the failing process and its message. Polling pattern (agents and clients):
  1. Call with withrollup=true.
  2. Re-call every few seconds until rollup.allDone is true.
  3. Read rollup.status for the outcome and rollup.jobs[].lastError for any failures.
Without withrollup=true, all three queries return their original array shapes (no wrapper) — backward compatible.
*Use one of publishertoken, pipelinetoken, or pipelinename. When multiple are supplied, publishertoken wins over pipelinetoken wins over pipelinename.

Clear All Status

Deletes all ingestion history — every status entry (the detail events returned by the token queries) and every job summary (the entries returned by the pipeline-name query). There are no parameters and no filtering: this is an all-or-nothing reset, typically used to clear out accumulated history on a dev or demo instance. Example:
Response: 200 OK — the total number of entries removed (detail entries plus summary entries combined):
This permanently removes the processing history for every pipeline, not just one. Pipeline configurations and loaded data are untouched — only the status/history records are deleted.

Status Fields

Each status entry (PipelineStatus) contains:

State Values

Process Names