OPopenobserve
Search

Get search result schema

Returns the schema definition for search results based on query parameters

post/api/{org_id}/result_schema

Request

Path parameters

org_idstring required

Organization name

Query parameters

is_streamingboolean

Describe the schema of a streaming query

cross_linkingboolean

Include cross-link fields

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

Success

group_bystring[] required
havingobject nullable
projectionsstring[] required
timeseries_fieldstring nullable
where_by_streamobject
where_clausestring

Changes

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