Skip to main content
GET
GET /v1/search/query

Search Entities

Full-text search across all entity types in the metadata catalog. Uses Elasticsearch query syntax under the hood.

Query Parameters

q
string
required
Search query string. Supports Elasticsearch query syntax including wildcards, boolean operators, and phrase matching.
index
string
default:"all"
Search index to query. Options: all, table_search_index, topic_search_index, dashboard_search_index, pipeline_search_index, mlmodel_search_index, container_search_index, search_entity_search_index, glossary_term_search_index, tag_search_index, user_search_index, team_search_index, domain_search_index, data_product_search_index.
from
integer
default:"0"
Starting offset for pagination.
size
integer
default:"10"
Number of results to return.
deleted
boolean
default:"false"
Include soft-deleted entities in the results.
sortField
string
Field to sort by (e.g., name, updatedAt, totalVotes).
sortOrder
string
Sort order: asc or desc.
trackTotalHits
boolean
default:"true"
Track exact total hit count. Set to false for faster queries when exact count is not needed.
getHierarchy
boolean
default:"false"
Include entity hierarchy in results.
fetchSource
boolean
default:"true"
Include the full source document in results. Set to false to return only metadata.
includeSourceFields
string
Comma-separated list of source fields to include. Use this to limit the response payload.
queryFilter
string
JSON query filter using Elasticsearch DSL. Applied before scoring.
postFilter
string
JSON post-filter using Elasticsearch DSL. Applied after scoring without affecting aggregations.
GET /v1/search/query

Returns

Returns an Elasticsearch-style response containing matched entities ranked by relevance score.

Response

took
integer
Time in milliseconds the search took to execute.
timed_out
boolean
Whether the search timed out.
hits
object
Search results container.

Error Handling