Skip to main content
GET
Get job status

Authorizations

x-api-key
string
header
required

Optional API key for authentication (enabled via application.yaml)

Query Parameters

publishertoken
string

Publisher token — returns status rows for every ingestion job sharing this token. Use this to watch a tap run (structured = 1 job, document = N jobs, all covered by one call). Wins over pipelinetoken if both supplied.

pipelinetoken
string

Pipeline token from upload

pipelinename
string

Pipeline name for summary view

page
integer
default:1

Page number for paginated results (pipelinename queries only)

withrollup
string
default:false

When "true" on a publishertoken or pipelinetoken query, wraps the response in {rollup, events}. rollup.allDone flips to true when every job reaches a terminal state; rollup.status is the aggregate outcome (success, warning, error, or processing); rollup.jobs[] carries per-job status (success, warning, error, processing, or timed_out) plus lastError on failures; events is the same raw entry array returned without the flag. Recommended for agents that need a single boolean to poll on. Ignored for pipelinename summary queries, which return their own rollup-equivalent shape.

Response

Job status information. An array of status entries by default; an object ({rollup, events} for token queries with withrollup=true, or the paginated summary shape for pipelinename queries) otherwise.

The response is of type object.