История изменений Public API в Yandex DataLens

В этом разделе собрана история изменений DataLens Public API. Подробнее про версионирование в документации.

Версия 3Версия 3

Сентябрь 2026Сентябрь 2026

Совместимые изменения в Public API версии 3.

1. Добавили заголовки ответа:

   • x-dl-api-stable-version — номер новой стабильной версии;
   • deprecation — наличие заголовка означает, что версия, через которую обращается пользователь, устарела. Содержит unix-timestamp даты выхода новой версии.

   Пример:

   x-dl-api-stable-version: 3
   deprecation: @1788825600
   

2. В метод getEntries:

   • добавили поле scopes;
   • для поля type изменили тип данных: string → string | string[], где string[] — массив из 1–10 элементов.

3. В метод getWorkbookEntries добавили значение scope в orderBy.field.

4. В схемах чартов в Editor добавили data.activities для таблиц, Gravity UI Charts и JS-селекторов.

5. В метод getTenantDetails добавили ответ с полями: tenantId, orgId, settings, dlpEnabled, foldersEnabled.

6. Актуализировали подключения:

   • Добавили поле ai_access_level.
   • Уточнили схемы создания, чтения и частичного обновления: обязательность полей, допустимость null и значения перечислений.
   • В схеме ответа createConnection добавили необязательное поле operation.
   • добавили поля dlp_managed_*, mode, variant в подключения ClickHouse®, MySQL® и PostgreSQL.
   • Для подключения Trino добавили поля extra_credentials,cluster_entry_id и form_fill_mode.

7. Актуализировали датасеты:

   • В схемах DatasetCreate, DatasetRead, DatasetUpdate добавили поля publishedId, revId, savedId.
   • В DatasetUpdate добавили поле mode со значениями save и publish (по умолчанию).
   • Расширили схемы источников и параметров запросов.

8. Добавили новые методы для работы в DataLens Platform со следующими объектами:

   • REST-каталоги;
   • кластеры Apache Spark™ и Trino;
   • SQL-запросы;
   • окружения;
   • бакеты.

9. Добавили метод getHtmlPagePreviewUrl.

10. В методе getHtmlPage добавили поддержку аудитного режима.

11. В методе getPermissions стали необязательными в ответе поля: approver, description, extras, requester.

08.09.2026 — переход на версию 308.09.2026 — переход на версию 3

1. Изменили схему аргументов/ответа методов для работы с чартами в визарде:

   • getWizardChart
   • createWizardChart
   • updateWizardChart

2. Изменили методы для работы с дашбордами и отчетами:

   • Добавили v2-версии методов получения, создания и обновления дашбордов и отчетов:

     • getDashboardV2
     • createDashboardV2
     • updateDashboardV2
     • getPresentationV2
     • createPresentationV2
     • updatePresentationV2

   • Из схем удалили поля:

     • schemeVersion — служебное поле версии у дашбордов;
     • data.version — служебное поле версии у отчетов;
     • data.description — вместо этого поля теперь используется annotation.description;
     • background — устаревшее поле оформления;
     • textColor — устаревшее поле оформления;
     • widgetTabId — устаревшее поле инсайта на дашборде.

   • Для dataset-селекторов fieldType теперь принимает только значения из перечисления типов данных датасета, например string, integer, date и genericdatetime. Для manual-селекторов поле fieldType сохраняется только у селекторов даты.

   • Добавили условие, при котором у дашбордов обязателен хотя бы один таб в data.tabs.

3. Миграции (при получении через метод getDashboardV2 или при сохранении в интерфейсе сущности v1):

   • Описание дашборда переносится из data.description в annotation.description.
   • Цвета фона всех виджетов переносятся из устаревшего background в backgroundSettings.color: {light, dark}, а цвет текста заголовка — из textColor в textSettings.color: {light, dark}. Конечный формат цвета — HEX.
   • При отсутствии существующего актуального widgetTabIds при миграции widgetTabId перенесется в формате массива с одним элементом widgetTabIds.

Версия 2Версия 2

28.07.202628.07.2026

Совместимые изменения в Public API версии 2.

1. Добавились методы для работы с HTML-страницами:

   • createHtmlPage
   • deleteHtmlPage
   • getHtmlPage
   • updateHtmlPage

2. Добавили методы для управления блокировками редактирования сущностей DataLens (например, чартов, дашбордов и т. д.):

   • createEntryLock
   • deleteEntryLock
   • extendEntryLock

3. Убрали тег [Experimental] с методов для работы с дашбордами:

   • createDashboard
   • deleteDashboard
   • getDashboard
   • updateDashboard

15.06.202615.06.2026

Совместимые изменения в Public API версии 2. Добавились методы:

• batchListMembers
• deleteFolder
• dlsSuggest
• getPermissions
• modifyPermissions
• moveFolderEntry

11.06.2026 — переход на версию 211.06.2026 — переход на версию 2

Несовместимые изменения с Public API версии 1. Изменилась версия Public API: теперь актуально Public API версии 2.

Несовместимое изменение затронуло метод getEntries, с помощью которого можно получать сущности Yandex DataLens.

1. Для поля ids изменился тип данных: string | string[] → string[].
2. Для поля createdBy изменился тип данных: string | string[] → string[].
3. Поле page с типом number удалено, вместо него добавлен pageToken с типом string.
4. Добавлено поле ignoreSharedEntries с типом boolean, которое позволяет исключать из ответа общие объекты.

Версия 1Версия 1

22.01.202622.01.2026

22 января 2026 года запущено DataLens Public API версии 1.

ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc.