Yandex DataLens Public API release notes
This section contains the DataLens Public API release notes. For more on versioning, see this guide.
Version 3
September 8, 2026: Upgrading to version 3
-
Revised the argument/response schemas in methods for working with wizard charts:
-
Updated methods for working with dashboards and reports:
-
Added v2 versions of methods for getting, creating, and updating dashboards and reports:
-
Removed these fields from the schemas:
schemeVersion: Service version field for dashboards.data.version: Service version field for reports.data.description: Replaced withannotation.description.background: Deprecated UI customization field.textColor: Deprecated UI customization field.widgetTabId: Deprecated field for dashboard insights.
-
For dataset selectors,
fieldTypenow only accepts values from the dataset's data types, e.g.,string,integer,date, andgenericdatetime. For manual selectors, thefieldTypefield is preserved only for date selectors. -
Added a requirement that dashboards must have at least one tab in
data.tabs.
-
-
Migrations (when obtained via the getDashboardV2
method or when saved in the v1 entity interface):- Migrated dashboard description from
data.descriptiontoannotation.description. - Migrated background colors of all widgets from the deprecated
backgroundtobackgroundSettings.color: {light, dark}, and the header text color, fromtextColortotextSettings.color: {light, dark}. The final color format isHEX. - If there is no existing current
widgetTabIdsduring migration,widgetTabIdmigrates as an array containing a single item (widgetTabIds).
- Migrated dashboard description from
Version 2
28.07.2026
Non-breaking changes in the Public API version 2.
-
Added methods for working with HTML pages:
-
Added methods for managing edit locks on DataLens entities, e.g., charts, dashboards, etc.:
-
Removed the
[Experimental]tag from dashboard management methods:
15.06.2026
Non-breaking changes in the Public API version 2. Added the following methods:
June 11, 2026: Upgrading to version 2
Breaking changes to the Public API version 1. A new Public API major version is out: Public API version 2.
Introduced breaking changes to the getEntries method for retrieving Yandex DataLens entities.
- Changed the
idsfield data type:string | string[]→string[]. - Changed the
createdByfield data type:string | string[]→string[]. - Removed the
pagefield of thenumbertype, replacing it withpageTokenof thestringtype. - Added a new
ignoreSharedEntriesfield of thebooleantype to remove shared objects from the response.
Version 1
22.01.2026
January 22, 2026: the DataLens Public API version 1 is out.