Get a job
The status and, when it finished, the result of a live site search.
Returns a job created by POST /v1/search/site. Poll it every couple of
seconds until status is succeeded or failed — or let the SDK do it with jobs.wait().
Jobs last one day and are visible only to the key that created them; after that, or with another key,
this returns 404 job_not_found.
Path
| Parameter | Type | |
|---|---|---|
id | string | The job id, from the 202 response or its Location header. |
Response
When the job succeeded, result is a search response with the same fields as
POST /v1/search.
idstringThe job id. Jobs last one day and are visible only to the key that created them.
object"job"Always
job.statusenum<string>queued,running,succeededorfailed.created_atstringWhen it was created.
finished_atstring | nullWhen it finished.
resultobject | nullWhen
succeeded: the search response, same shape asPOST /v1/search.errorobject | nullWhen
failed: the problem details.Show child attributes
typestringurn:typesearch:error:<code>.titlestringA short summary of the status.
statusintegerThe HTTP status.
detailstringWhat went wrong, for people.
codestringA stable error code, for programs.
request_idstringInclude it when you contact support.
errorsobject[]Field-level validation errors, when the request was invalid.
Show child attributes
pathstringThe field, e.g.
query.messagestringWhat is wrong with it.