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

string
required
Search query string. Supports Elasticsearch query syntax including wildcards, boolean operators, and phrase matching.
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.
integer
default:"0"
Starting offset for pagination.
integer
default:"10"
Number of results to return.
boolean
default:"false"
Include soft-deleted entities in the results.
string
Field to sort by (e.g., name, updatedAt, totalVotes).
string
Sort order: asc or desc.
boolean
default:"true"
Track exact total hit count. Set to false for faster queries when exact count is not needed.
boolean
default:"false"
Include entity hierarchy in results.
boolean
default:"true"
Include the full source document in results. Set to false to return only metadata.
string
Comma-separated list of source fields to include. Use this to limit the response payload.
string
JSON query filter using Elasticsearch DSL. Applied before scoring.
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

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

Error Handling