MEmetabase
/api/search

GET /api/search/debug

Changed on

Superuser-only. Explain why expected_result_id / expected_result_type does not appear in the results of the given search query. Accepts every GET /api/search parameter plus the two expected-result parameters, and returns {:type ..., :details ...} for the first stage that drops the item: not-searchable, missing-from-index, not-permitted, filtered, not-matching, or the terminal matched / ranked-out.

  • for_user_id: diagnose from another user's perspective (defaults to you). Permission and visibility checks run as that user, so a not-permitted result means they can't see the item.

Not supported for indexed-entity (its id is compound).

get/api/search/debug

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Query parameters

vector_search_ef_searchinteger nullable
expected_result_type'dashboard' | 'table' | 'exploration' | 'dataset' | 'segment' | 'collection' | 'measure' | 'transform' | 'document' | 'database' | 'data-app' | 'action' | 'indexed-entity' | 'metric' | 'card' required
qstring nullable
collectioninteger nullable

value must be an integer greater than zero.

vector_search_explainboolean nullable
created_byinteger[] nullable
include_metadataboolean nullable
idsinteger[] nullable
archivedboolean nullable
verifiedboolean nullable
last_edited_byinteger[] nullable
context'basic-actions' | 'browse' | 'command-palette' | 'data-picker' | 'dependencies' | 'document' | 'embedding-setup' | 'entity-picker' | 'library' | 'model-migration' | 'search-app' | 'search-bar' | 'type-filter' | 'api' | 'metabot'
vector_search_strategy'hnsw' | 'brute-force' | 'hnsw-iterative-relaxed' | 'hnsw-iterative-strict' nullable
model_ancestorsboolean nullable
calculate_available_modelsboolean nullable
display_typestring[] nullable
expected_result_idinteger required

value must be an integer greater than zero.

created_atstring nullable

value must be a non-blank string.

for_user_idinteger nullable

value must be an integer greater than zero.

modelsstring[] nullable
last_edited_atstring nullable

value must be a non-blank string.

search_native_queryboolean nullable
table_db_idinteger nullable

value must be an integer greater than zero.

include_dashboard_questionsboolean nullable
vector_search_max_scan_tuplesinteger nullable
filter_items_in_personal_collection'all' | 'only' | 'only-mine' | 'exclude' | 'exclude-others' nullable
search_enginestring nullable

Response

Successful response

Changes