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

Field Query

Search for entities by matching a specific field to a given value. This is useful for finding entities that have a particular column name, tag, owner, or other field-level attribute.

Query Parameters

fieldName
string
required
Field path to search. Common values: columns.name, tags.tagFQN, owners.name, service.name, database.name, databaseSchema.name.
fieldValue
string
required
Value to match against the specified field.
index
string
required
Search index to query. Options: 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.
GET /v1/search/fieldQuery

Returns

Returns an Elasticsearch-style response containing entities where the specified field matches the given value.

Response

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

Common Field Paths


Error Handling