# Пульс

/api/pulse методы.

## `DELETE /api/pulse/:id/subscription`

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

### Параметры:

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

## `GET /api/pulse/`

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

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

Если `created_or_receive` равно `true` - возвращает все подписки, которые создал текущий пользователь *или* для которых он является получателем.
Обратите внимание, что это надмножество по умолчанию возвращаемых элементов для не-администраторов и подмножество по умолчанию возвращаемых элементов для администраторов. Это используется для работы страницы /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`.

### Параметры:

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

## `GET /api/pulse/preview_card_info/:id`

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

### Параметры:

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

## `GET /api/pulse/preview_card_png/:id`

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

### Параметры:

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

## `GET /api/pulse/preview_dashboard/:id`

Получить HTML рендеринг дашборда с `id`.

Данная конечная точка полагается на пользовательское промежуточное программное обеспечение, определенное в `metabase.pulse.preview/style-tag-nonce-middleware` чтобы тег стиля отображался правильно, учитывая нашу настройку политики безопасности контента. Это промежуточное ПО присоединяется к этим маршрутам в нижней части этого пространства имен с помощью `metabase.api.common/define-routes`.

### Параметры:

*  **`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](./api-documentation.md)