# Волшебные (автоматические) дашборды

API метод для автоматических дашбордов.

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query`

Возвращает автоматический дашборд для сущности `entity`с id `id`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`show`**  должно соответствовать all, допускается пустое значение.

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query`

Возвращает автоматический дашборд, анализирующую ячейку для сущности `entity`, определенной запросом `cell-query`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`cell-query`** значение не может быть распознано как JSON, закодированный в base64;

* **`show`** недопустимое значение для отображения.

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/compare/:comparison-entity/:comparison-entity-id-or-query`

Возвращает автоматический дашборд для ячейки в автоматическом дашборде для сущности `entity` с идентификатором `id`, определенной запросом `cell-query`, сравненной с сущностью `comparison-entity` с id `comparison-entity-id-or-query`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`cell-query`** значение не может быть распознано как JSON, закодированный в base64;

* **`show`** недопустимое значение для отображения;

* **`comparison-entity`** Недопустимое сравнение типа сущности. Может быть только одним из "table", "segment", или "adhoc";

* **`comparison-entity-id-or-query`**

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:rule`

Возвращает автоматический дашборд для анализа ячейки в вопросе с id `id`, определенной запросом `cell-query` с использованием правила `rule`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`cell-query`** значение не может быть распознано как JSON, закодированный в base64;

* **`prefix`** недопустимое значение префикса;

* **`rule`** недопустимое значение для названия правила;

* **`show`** недопустимое значение для отображения.

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/cell/:cell-query/rule/:prefix/:rule/compare/:comparison-entity/:comparison-entity-id-or-query`

Возвращает автоматический дашборд для ячейки для сущности entity с id `id`, определенной запросом `cell-query` с использованием правила `rule`; сравнивая с сущностью `comparison-entity` с id `comparison-entity-id-or-query`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`cell-query`** значение не может быть распознано как JSON, закодированный в base64;

* **`prefix`** недопустимое значение для префикса;

* **`rule`** недопустимое значение для названия правила;

* **`show`** недопустимое значение для отображения;

* **`comparison-entity`** недопустимое сравнение типа сущности. Может быть только одним из "table", "segment", или "adhoc".

* **`comparison-entity-id-or-query`**

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/compare/:comparison-entity/:comparison-entity-id-or-query`

Возвращает автоматический дашборд для сущности `entity` с id `id`, сравненной с сущностью `comparison-entity` с id `comparison-entity-id-or-query`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`show`** недопустимое значение для отображения;

* **`comparison-entity`** недопустимое сравнение типа сущности. Может быть только одним из "table", "segment", или "adhoc";

* **`comparison-entity-id-or-query`**

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:rule`

Возвращает автоматический дашборд для сущности `entity` с id `id` используя правило `rule`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`prefix`** недопустимое значение для префикса;

* **`rule`** недопустимое значение названия правила;

* **`show`** недопустимое значение для отображения.

## `GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:rule/compare/:comparison-entity/:comparison-entity-id-or-query`

Возвращает автоматический дашборд для сущности `entity` с id `id` используя правило `rule`; сравнение с сущностью `comparison-entity` с id `comparison-entity-id-or-query`.

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

* **`entity`** недопустимый тип сущности;

* **`entity-id-or-query`**

* **`prefix`** недопустимое значение для префикса;

* **`rule`** недопустимое название правила;

* **`show`** недопустимое значение для отображения;

* **`comparison-entity`** недопустимое сравнение типа сущности. Может быть только одним из "table", "segment", или "adhoc";

* **`comparison-entity-id-or-query`**

## `GET /api/automagic-dashboards/database/:id/candidates`

Возвращает список кандидатов для автоматического дашборда, отсортированный по степени "интереса".

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

* **`id`** значение должно быть целым числом больше нуля.

---

[<< Назад к разделу API](./api-documentation.md)