搜索

搜索的API端点。

GET /api/search/

在Metabase中搜索项目。有关支持模型的列表,请参阅[[metabase.search/all-models]]。

过滤器

  • archived:设置为true仅搜索存档项目,默认为false
  • table_db_id:搜索特定数据库的表、卡片和模型
  • models:仅搜索特定模型的项。如果未提供,则搜索所有模型
  • filters_items_in_personal_collection:仅搜索个人收藏中的项
  • created_at:搜索在特定时间戳创建的项
  • created_by:搜索由特定用户创建的项
  • last_edited_at:搜索在特定时间戳最后编辑的项
  • last_edited_by:搜索由特定用户最后编辑的项
  • search_native_query:设置为true以搜索原生查询的内容
  • verified:设置为true以仅搜索已验证的项(需要内容管理或官方收藏高级功能)
  • ids:搜索具有这些ID的项,如果传递给models的单个值,则有效

请注意,并非所有项目类型都支持所有过滤器,结果将仅包括支持提供的过滤器的模型。例如

  • created-by过滤器支持仪表板、模型、操作和卡片。
  • verified过滤器支持模型和卡片。

应用了两个过滤器的搜索查询将仅返回模型和卡片。

参数

  • filter_items_in_personal_collection可为null的枚举值只有only, exclude。

  • table_db_id可为null的值必须是一个大于零的整数。

  • created_by可为null的值必须是一个大于零的整数。

  • verified可为null的布尔值。

  • created_at可为null的值必须是一个非空字符串。

  • archived可为null的布尔值。

  • q可为null的值必须是一个非空字符串。

  • ids可为null的值必须是一个大于零的整数。

  • search_native_query可为null的布尔值。

  • models可为null的值必须是一个枚举值,可以是dashboard、table、dataset、segment、collection、database、action、indexed-entity、metric、card。

  • search_engine可为null的字符串。

  • last_edited_by可为null的值必须是一个大于零的整数。

  • last_edited_at可为null的值必须是一个非空字符串。

  • model_ancestors可为null的布尔值。

GET /api/search/models

获取搜索查询将返回的模型集。

参数

  • filter_items_in_personal_collection

  • created_by可为null的值必须是一个大于零的整数。

  • verified可为null的布尔值。

  • created_at可为null的值必须是一个非空字符串。

  • archived 可空值必须是有效的布尔字符串('true' 或 'false')。

  • q

  • search_native_query可为null的布尔值。

  • search_engine可为null的字符串。

  • last_edited_by可为null的值必须是一个大于零的整数。

  • last_edited_at 可空值必须是一个大于零的整数。

  • table-db-id 可空值必须是一个大于零的整数。

POST /api/search/force-reindex

如果启用了全文搜索,这将触发一个同步重新索引操作。

您必须是一位超级用户才能执行此操作。


« 返回API索引

阅读其他Metabase版本的文档。

想改进这些文档吗? 提出更改。