OPopenobserve
Search Jobs

Submit search job

Submits a new asynchronous search job for execution. Search jobs are useful for long-running queries that might exceed normal timeout limits or for scheduling queries to run in the background. The job is queued for execution and returns a job ID that can be used to monitor progress and retrieve results later.

post/api/{org_id}/search_jobs

Request

Path parameters

org_idstring required

Organization name

Request body

clear_cacheboolean
clustersstring[]
encoding'base64' | 'Empty'
local_modeboolean nullable
regionsstring[]
search_type'ui' | 'dashboards' | 'reports' | 'alerts' | 'values' | 'other' | 'rum' | 'derivedstream' | 'searchjob' | 'download' | 'insights' | 'public_dashboard'
timeoutinteger
use_cacheboolean
use_indexboolean

Set to false to skip the inverted index for this query.

Response

Search Job submitted successfully

codeinteger required
error_detailstring nullable
hintstring nullable

One-line guidance on how to fix the error (agent self-correction, D4).

idstring nullable
messagestring required
namestring nullable
suggestionsstring[] nullable

Closest valid alternatives for a mistyped field/function name.

trace_idstring nullable
warningsstring[] nullable

Problems with a request that succeeded anyway. Distinct from hint, which explains a failure: these accompany a 200, and the caller is entitled to have meant it.

Changes

No recorded changes to this operation across all 1 revision of this API.