---

title: "Предварительный просмотр встраивания" summary: | Эндпоинты для предварительного просмотра карточек и дашбордов в случае их встраивания. redirect_from: - /ru/docs/latest/api/preview-embed

---

Предварительный просмотр встраивания

Эндпоинты для предварительного просмотра карточек и дашбордов в случае их встраивания. Эти методы в основном идентичны по функциональности методам /api/embed, со следующими дополнениями:

1. Требуется админский доступ.

2. Игнорирует значения :enabled_embedding для Карточек/Дашбордов.

3. Игнорирует белый список :embed_params для Карточек/Дашбордов, вместо этого испоьзует поле с названием :_embedding_params в самом JWT токене.

Обратитесь к документации по этим методам за подробностями.

GET /api/preview-embed/card/:token

Получить Карточку, которую вы рассматриваете для встраивания через передачу JWT token.

Параметры:

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

GET /api/preview-embed/card/:token/query

Получить результаты запроса для Карточки, которую вы рассматриваете для встраивания через передачу JWT token.

Параметры:

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

• &

• query-params

GET /api/preview-embed/dashboard/:token

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

Параметры:

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

GET /api/preview-embed/dashboard/:token/dashcard/:dashcard-id/card/:card-id

Получить результаты запуска Карточки, принадлежащей Дашборду, который вы планируете встроить с помощью JWT token.

Параметры:

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

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

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

• &

• query-params

GET /api/preview-embed/dashboard/:token/params/:param-key/values

Встроенная версия endpoint для значений цепочечного фильтра.

Параметры:

• token

• param-key

• query-params

GET /api/preview-embed/pivot/card/:token/query

Получить результат запроса Карточки, которую вы планируете встроить с помощью передачи JWT token.

Параметры:

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

• &

• query-params

GET /api/preview-embed/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id

Получить результаты работающей Карточки, принадлежащей Дашборду, который вы планируете встроить с JWT token.

Параметры:

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

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

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

• &

• query-params

POST /api/preview-embed/card/:token/query/export/:export-format

Экспортировать результаты запроса Карточки, которую вы рассматриваете для встраивания через передачу JWT token, в указанном формате.

Параметры:

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

• export-format значение должно быть одним из csv, json, xlsx, pdf, png.

• parameters

• format_rows значение должно быть валидной логической строкой ('true' или 'false').

• pivot_results значение должно быть валидной логической строкой ('true' или 'false').

POST /api/preview-embed/dashboard/:dashboard-id/dashcard/:dashcard-id/card/:card-id/export/:export-format

Экспортировать результаты запуска Карточки, принадлежащей Дашборду, который вы планируете встроить.

Параметры:

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

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

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

• export-format значение должно быть одним из csv, json, xlsx, pdf, png.

• parameters

• token

• format_rows значение должно быть валидной логической строкой ('true' или 'false').

• pivot_results значение должно быть валидной логической строкой ('true' или 'false').

POST /api/preview-embed/pivot/card/:token/query

Обновить результаты запроса Карточки сводной таблицы, которую вы рассматриваете для встраивания через передачу JWT token.

Параметры:

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

• query-params

POST /api/preview-embed/pivot/dashboard/:token/dashcard/:dashcard-id/card/:card-id

Обновить результаты запуска Карточки сводной таблицы, принадлежащей Дашборду, который вы планируете встроить с помощью JWT token.

Параметры:

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

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

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

• query-params

---

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