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

Пульс

/api/pulse методы. Все эти методы требуют авторизации. Для неаутентифицированных /api/pulse/unsubscribe методов, смотрите [[metabase.api.pulse.unsubscribe]].

Устаревшие: вскоре будут мигрированы в API уведомлений.

DELETE /api/pulse/:id/subscription

Отписка пользователей от подписки на пульс.

Параметры:

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

GET /api/pulse/

Получить все подписки на дашборды. По умолчанию возвращает только подписки, для которых текущий пользователь имеет права на запись. Для администраторов это все подписки; для не-администраторов это только те подписки, которые они создали.

Если dashboard_id указан, ограничивает результаты подпиской, связанной с данным дашбордом.

Если created_or_receive равно `tru — возвращает все подписки, которые создал текущий пользователь или для которых он является получателем. Обратите внимание, что это надмножество по умолчанию возвращаемых элементов для не-администраторов и подмножество по умолчанию возвращаемых элементов для администраторов. Это используется для работы страницы /account/notifications. Это может включать подписки, для которых у текущего пользователя нет разрешений, в этом случае некоторая конфиденциальная метаинформация (список карт и получателей) удаляется.

Параметры:

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

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

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

GET /api/pulse/:id

Получить пульс Pulse с ID. Если пользователь - получатель Пульса, но не имеет прав на чтение его коллекции, мы всё равно возвращаем его, но с некоторой удалённой конфиденциальной метаинформацией.

Параметры:

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

GET /api/pulse/form_input

Предоставляет соответствующую информацию о конфигурации и настройки пользователя для создания/обновления Пульсов.

GET /api/pulse/preview_card/:id

Получить HTML интерпретацию Карточки с id.

Этот метод полагается на пользовательское промежуточное программное обеспечение, определённое в metabase.channel.render.core/style-tag-nonce-middleware, чтобы позволить тегу style отображаться правильно, учитывая нашу настройку Content Security Policy. Это промежуточное ПО прикрепляется к этим маршрутам в нижней части этого пространства имён, используя metabase.api.common/define-routes.

Параметры:

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

GET /api/pulse/preview_card_info/:id

Получить объект JSON, содержащий HTML-рендеринг Карточки с id и другой информацией.

Параметры:

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

GET /api/pulse/preview_card_png/:id

Получить PNG изображение Карточки с id.

Параметры:

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

POST /api/pulse/

Создать новый Pulse.

Параметры:

  • name непустая строка.

  • cards одно или более значений, которые должны быть картой (картами) со следующими ключами: (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings), или значение должно быть картой с ключами id, include_csv, include_xls и dashboard_card_id.

  • channels карта - одна или более.

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

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

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

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

  • parameters последовательность карт или null.

POST /api/pulse/test

Тестовая отправка несохранённого Пульса.

Параметры:

  • name непустая строка.

  • cards одно или более значений, которые должны быть картой (картами) со следующими ключами: (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings), или значение должно быть картой с ключами id, include_csv, include_xls и dashboard_card_id.

  • channels карта - одна или более.

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

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

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

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

PUT /api/pulse/:id

Обновить Пульс с id.

Параметры:

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

  • parameters последовательность карт или null.

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

  • channels одна или более карт или null.

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

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

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

  • cards одно или более значений, которые должны быть картой (картами) со следующими ключами: (collection_id, description, display, id, include_csv, include_xls, name, dashboard_id, parameter_mappings), или значение должно быть картой с ключами id, include_csv, include_xls и dashboard_card_id, или null.

  • pulse-updates

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