Stream Job Status

Request

Returns progress counters for a stream job. Poll to track completion without consuming webhook deliveries.

Security

ApiKeyAuth or BearerAuth or BasicAuth

Path

idstringrequired

MongoDB ObjectId of the stream job.

Example:64f1c2d3e4b5a6c7d8e9f0a1

curl -i -X GET \
  https://docs.kwery.co/_mock/api-reference/stream/64f1c2d3e4b5a6c7d8e9f0a1 \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Stream job status

Bodyapplication/json

One of:

errorboolean

Example:false

job_idstring

statusstring(JobStatus)

Value	Meaning
`new`	Created, queued for processing
`working`	Crawls in progress
`finished`	All results assembled
`failed`	Timed out or unrecoverable error

Enum:"new""working""finished""failed"

sourcestring

countrystring

values_totalinteger

Total values submitted.

values_doneinteger

Values with a result (success or error).

values_errorsinteger

Values that resulted in an error.

is_finalboolean

true when all values have been processed.

created_atstring, (date-time)

finished_atstring or null, (date-time)

client_refstring or null

Response

{
  "error": false,
  "job_id": "64f1c2d3e4b5a6c7d8e9f0a1",
  "status": "working",
  "source": "idealo",
  "country": "de",
  "values_total": 1000,
  "values_done": 452,
  "values_errors": 3,
  "is_final": false,
  "created_at": "2026-04-03T10:00:00.000Z",
  "finished_at": null,
  "client_ref": "batch-2026-04-03"
}