Перейти к содержанию

Поиск

API методы для поиска.

GET /api/search/

Поиск элементов в GlarusBI.

Список поддерживаемых моделей см. в [[metabase.search.config/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 для поиска только верифицированных элементов (требуется премиум-функция "Управление контентом" или "Официальные коллекции").

Обратите внимание, что не все типы элементов поддерживают все фильтры, и результаты будут включать только модели, поддерживающие предоставленные фильтры. Например:

  • Фильтр created-by поддерживает дашборды, модели, действия и карточки.
  • Фильтр verified поддерживает модели и карточки.

Поисковый запрос, к которому применены оба фильтра, вернёт только модели и карточки.

Параметры:

  • filter_items_in_personal_collection nullable enum of only, exclude
  • table_db_id целое число больше нуля или null.
  • created_by null, целое число больше нуля или последовательность целых чисел больше нуля.
  • verified true или null.

  • created_at непустая строка или null.

  • archived логическое значение или null.

  • q непустая строка или null.

  • search_native_query true или null.

  • models null или одно из: dashboard, table, dataset, segment, collection, database, action, indexed-entity, metric, card; или последовательность из: dashboard, table, dataset, segment, collection, database, action, indexed-entity, metric, card.

  • last_edited_by null, целое число больше нуля или последовательность целых чисел больше нуля.

  • last_edited_at непустая строка или null.

  • context null или одно из: search-bar, search-app.

GET /api/search/models

Получить набор моделей, которые вернёт поисковый запрос.

Параметры:

  • filter_items_in_personal_collection

  • created_by null, целое число больше нуля или последовательность целых чисел больше нуля.

  • verified true или null.

  • created_at непустая строка или null.

  • archived допустимая логическая строка (true или false) или null.

  • q

  • search_native_query true или null.

  • last_edited_by null, целое число больше нуля или последовательность целых чисел больше нуля.

  • last_edited_at целое число больше нуля или null.

  • table-db-id целое число больше нуля или null.

<< Назад к разделу API