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

title: "Волшебные (автоматические) дашборды" summary: | /api/automagic-dashboards методы. redirect_from: - /ru/docs/latest/api/automagic-dashboards

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

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/:dashboard-template

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

ПАРАМЕТРЫ:

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

  • entity-id-or-query значение должно быть непустой строкой.

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

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

  • dashboard-template недопустимое значение для названия шаблона дашборда;

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

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

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

ПАРАМЕТРЫ:

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

  • entity-id-or-query значение должно быть непустой строкой.

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

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

  • dashboard-template недопустимое значение для названия шаблона дашборда;

  • 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/query_metadata

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

ПАРАМЕТРЫ:

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

  • entity-id-or-query

GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template

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

ПАРАМЕТРЫ:

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

  • entity-id-or-query значение должно быть непустой строкой.

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

  • dashboard-template недопустимое значение названия шаблона дашборда;

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

GET /api/automagic-dashboards/:entity/:entity-id-or-query/rule/:prefix/:dashboard-template/compare/:comparison-entity/:comparison-entity-id-or-query

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

ПАРАМЕТРЫ:

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

  • entity-id-or-query значение должно быть непустой строкой.

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

  • dashboard-template недопустимое значение названия шаблона дашборда;

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

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

  • comparison-entity-id-or-query

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

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

ПАРАМЕТРЫ:

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

GET /api/automagic-dashboards/model_index/:model-index-id/primary_key/:pk-id

Возвращает автоматический дашборд для детализации сущности, указанной entity с id id и первичным ключом indexed-value.

ПАРАМЕТРЫ:

  • model-index-id целое число.

  • pk-id целое число.