Get Status by Publisher Token
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).
| Parameter | Type | Required | Description |
|---|---|---|---|
publishertoken | query | Yes | Publisher token returned from /tap/run (publisherToken field) or upload_data |
withrollup | query | No | When true, wraps the response in a rollup object that classifies each job — see Rollup Response below. Recommended for agents that need a single boolean to poll on. |
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
| Parameter | Type | Required | Description |
|---|---|---|---|
pipelinetoken | query | Yes* | Pipeline token from upload response |
withrollup | query | No | When true, wraps the response in a rollup object — see Rollup Response. |
200 OK - an array of status entries, one per processing stage:
Get Status by Pipeline Name
| Parameter | Type | Required | Description |
|---|---|---|---|
pipelinename | query | Yes* | Pipeline name |
page | query | No | Page number (default: 1) |
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):
- Call with
withrollup=true. - Re-call every few seconds until
rollup.allDoneistrue. - Read
rollup.statusfor the outcome androllup.jobs[].lastErrorfor any failures.
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.
Status Fields
Each status entry (PipelineStatus) contains:
| Field | Description |
|---|---|
id | Entry index (internal) |
dateTime | Human-readable timestamp |
pipeline | Pipeline name |
processName | Processing stage name (see below) |
publisherToken | Publisher identifier (if provided on upload) |
pipelineToken | Pipeline job token |
filename | Source filename |
state | Stage state: begin, processing, end, or error |
code | Same as state |
description | Detail message |
epoch | Unix epoch milliseconds |
State Values
| State | Description |
|---|---|
begin | Processing stage started |
processing | In progress with detail message |
end | Processing stage completed |
error | Processing stage failed |
Process Names
| Process | Description |
|---|---|
FileNotifier | File intake from MinIO bucket |
StreamNotifier | Direct upload intake |
DataQuality | Data quality validation |
Transformation | Data transformation |
JobRunner | Destination orchestration |
PostgresLoader | PostgreSQL loading |
MongoDBLoader | MongoDB loading |
SparkObjectStoreLoader | Object store writing |
KafkaLoader | Kafka producing |
ActiveMQLoader | ActiveMQ queue writing |
RestEndpointRunner | REST endpoint posting |
