Skip to content

Datalens MCP tools

134 tools.

datalens_tenant_details_get

Get the DataLens instance · read-only

The DataLens instance the credentials reach (a safe auth probe).

datalens_collections_get

Get DataLens collection · read-only

One collection by id: its title, description and parent.

Parameter Type Required Description
collection_id string yes Collection id.
include_permissions_info boolean or null Also say what the caller may do with it.

datalens_collections_list_by_ids

List DataLens collections by id · read-only

The collections with these ids; an id the caller cannot see is left out.

Parameter Type Required Description
collection_ids array of string yes Collection ids.

datalens_collections_content_list

List the content of a DataLens collection · read-only

What a collection holds: collections, workbooks and entries, auto-paginated.

Start here to find a workbook: list the root, then descend. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
collection_id string or null Collection id; null lists the root.
limit integer or null Max items to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
filter_string string or null Keep the items whose title has this text.
order_field title · createdAt · updatedAt or string or null What to sort by.
order_direction asc · desc or string or null Sort direction.
only_my boolean or null Keep only what the caller created.
mode all · onlyCollections · onlyWorkbooks · onlyEntries or string or null Which kinds of items to list.
include_permissions_info boolean or null Also say what the caller may do with it.

datalens_collections_breadcrumbs_list

List the path of a DataLens collection · read-only

The collections from the root down to this one.

Parameter Type Required Description
collection_id string yes Collection id.
include_permissions_info boolean or null Also say what the caller may do with it.

datalens_collections_permissions_get_root

Get DataLens root permissions · read-only

Whether the caller may create a collection and a workbook in the root.

datalens_collections_access_bindings_list

List the roles on a DataLens collection · read-only

Who has which role on a collection, auto-paginated.

Parameter Type Required Description
collection_id string yes Collection id.
limit integer or null Max subjects to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
get_inherited_bindings boolean or null Also list the roles inherited from above.

datalens_collections_create

Create DataLens collection · write

Create a collection in another one, or in the root when no parent is given.

Parameter Type Required Description
title string yes Title of the collection.
parent_id string or null The collection to put it in; the root when left out.
description string or null Description of the collection.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_update

Update DataLens collection · idempotent write

Change a collection's title or description; what is not given stays as it is.

Parameter Type Required Description
collection_id string yes Collection id.
title string or null New title.
description string or null New description.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_move

Move DataLens collection · write

Move a collection into another one, or into the root when no parent is given.

Parameter Type Required Description
collection_id string yes Collection id.
parent_id string or null The collection to put it in; the root when left out.
title string or null New title to give it on the way.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_move_bulk

Move DataLens collections · write

Move several collections into another one, or into the root when none is given.

All or none: if one collection already lies in the destination, the API answers 409 and moves none of them.

Parameter Type Required Description
collection_ids array of string yes Collection ids.
parent_id string or null The collection to put it in; the root when left out.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_delete

Delete DataLens collection · destructive write

Delete a collection with everything it holds: nested collections, workbooks, entries.

Parameter Type Required Description
collection_id string yes Collection id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_delete_bulk

Delete DataLens collections · destructive write

Delete several collections with everything they hold.

Parameter Type Required Description
collection_ids array of string yes Collection ids.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_collections_access_bindings_update

Change the roles on a DataLens collection · write

Give or take away roles on a collection; the roles not named stay as they are.

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
collection_id string yes Collection id.
deltas array of object yes The roles to add (ADD) and remove.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_get

Get DataLens workbook · read-only

One workbook by id: its title, description and collection.

Parameter Type Required Description
workbook_id string yes Workbook id.
include_permissions_info boolean or null Also say what the caller may do with it.

datalens_workbooks_list

List DataLens workbooks · read-only

The workbooks of one collection (the root by default), auto-paginated.

It does not descend into nested collections: collections_content_list shows what a collection holds. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
limit integer or null Max workbooks to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
collection_id string or null Collection to list; the root when left out.
filter_string string or null Keep the workbooks whose title has this text.
order_field title · createdAt · updatedAt or string or null What to sort by.
order_direction asc · desc or string or null Sort direction.
only_my boolean or null Keep only what the caller created.
include_permissions_info boolean or null Also say what the caller may do with it.

datalens_workbooks_list_by_ids

List DataLens workbooks by id · read-only

The workbooks with these ids; an id the caller cannot see is left out.

Parameter Type Required Description
workbook_ids array of string yes Workbook ids.

datalens_workbooks_access_bindings_list

List the roles on a DataLens workbook · read-only

Who has which role on a workbook, auto-paginated.

Parameter Type Required Description
workbook_id string yes Workbook id.
limit integer or null Max subjects to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
get_inherited_bindings boolean or null Also list the roles inherited from above.

datalens_workbooks_entries_list

List the entries of a DataLens workbook · read-only

What a workbook holds: connections, datasets, charts and dashboards, auto-paginated.

scope says the kind of each entry; its id opens it with the tools of that kind. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
workbook_id string yes Workbook id.
limit integer or null Max entries to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
include_permissions_info boolean or null Also say what the caller may do with it.
only_my boolean or null Keep only what the caller created.
created_by string or null Keep only what this user created.
scope array of dash · report · widget · dataset · folder · connection · compute · artifact · sql_query or string or null Keep only these kinds of entries.
order_by object or null What to sort by and in which direction.
filters object or null Keep the entries whose name has a text.

datalens_workbooks_create

Create DataLens workbook · write

Create a workbook in a collection, or in the root when no collection is given.

Parameter Type Required Description
title string yes Title of the workbook.
collection_id string or null The collection to put the workbook in; the root when left out.
description string or null Description of the workbook.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_update

Update DataLens workbook · idempotent write

Change a workbook's title or description; what is not given stays as it is.

Parameter Type Required Description
workbook_id string yes Workbook id.
title string or null New title.
description string or null New description.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_move

Move DataLens workbook · write

Move a workbook into a collection, or into the root when no collection is given.

Parameter Type Required Description
workbook_id string yes Workbook id.
collection_id string or null The collection to put the workbook in; the root when left out.
title string or null New title to give it on the way.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_move_bulk

Move DataLens workbooks · write

Move several workbooks into a collection, or into the root when none is given.

All or none: if one workbook already lies in the destination, the API answers 409 and moves none of them.

Parameter Type Required Description
workbook_ids array of string yes Workbook ids.
collection_id string or null The collection to put the workbook in; the root when left out.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_delete

Delete DataLens workbook · destructive write

Delete a workbook with everything it holds: connections, datasets, charts, dashboards.

Deleting a workbook that is already deleted answers 500, not 404: after a server error, read the workbook before deleting it again.

Parameter Type Required Description
workbook_id string yes Workbook id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_delete_bulk

Delete DataLens workbooks · destructive write

Delete several workbooks with everything they hold.

Parameter Type Required Description
workbook_ids array of string yes Workbook ids.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbooks_access_bindings_update

Change the roles on a DataLens workbook · write

Give or take away roles on a workbook; the roles not named stay as they are.

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
workbook_id string yes Workbook id.
deltas array of object yes The roles to add (ADD) and remove.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_entrylocks_create

Lock a DataLens entry · write

Lock an entry (a dataset, a chart, a dashboard) for editing.

The reply holds the token of the lock and nothing else: keep it, extending and releasing the lock take it. An entry that is already locked answers 423 with who holds the lock and until when.

Parameter Type Required Description
entry_id string yes Entry id.
data object yes How long to hold the lock, in milliseconds.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_entrylocks_extend

Extend the lock of a DataLens entry · idempotent write

Hold a lock longer; the reply says when it expires now.

Parameter Type Required Description
entry_id string yes Entry id.
data object yes The token of the lock and its new terms.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_entrylocks_delete

Release the lock of a DataLens entry · destructive write

Release a lock; with force it releases a lock another editor holds.

An entry that is not locked answers 404.

Parameter Type Required Description
entry_id string yes Entry id.
params object yes The token of the lock, or force for another's lock.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkclusters_list

List DataLens Spark clusters · read-only

The Spark clusters of DataLens, auto-paginated.

Experimental API, not measured: ycli follows its document. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
limit integer or null Max clusters to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
collection_id string or null Keep the clusters of one collection.
filter array of string or null Filter expressions of the API.

datalens_sparkclusters_get

Get DataLens Spark cluster · read-only

One Spark cluster: its settings, health and status. Experimental API, not measured.

Parameter Type Required Description
id string yes Spark cluster id.

datalens_sparkclusters_create

Create DataLens Spark cluster · write

Create a Spark cluster and return the operation that creates it.

A cluster is paid for while it runs: create one only when asked to. The operation goes on after the reply: lakehouseoperations_get with its id says how it ended. Experimental API, not measured.

Parameter Type Required Description
collection_id string yes The collection to create the cluster in.
cloud_environment_id string yes The cloud environment the cluster runs in.
name string yes The cluster's name.
config object yes The Spark version and the pools of the driver and executors.
description string or null A description of the cluster.
labels object or null Labels of the cluster.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkclusters_delete

Delete DataLens Spark cluster · destructive write

Delete a Spark cluster and return the operation; lakehouseoperations_get reads it.

Experimental API, not measured.

Parameter Type Required Description
id string yes Spark cluster id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkclusters_start

Start DataLens Spark cluster · write

Start a stopped Spark cluster and return the operation.

A cluster is paid for while it runs: start one only when asked to. lakehouseoperations_get says how the operation ended. Experimental API, not measured.

Parameter Type Required Description
cluster_id string yes Spark cluster id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkclusters_stop

Stop DataLens Spark cluster · write

Stop a running Spark cluster and return the operation; lakehouseoperations_get reads it.

Experimental API, not measured.

Parameter Type Required Description
cluster_id string yes Spark cluster id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkclusters_resource_presets_list

List DataLens Spark resource presets · read-only

The sizes an instance of a Spark cluster can take, auto-paginated.

Experimental API, not measured. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
cloud_environment_id string yes The cloud environment the presets are for.
limit integer or null Max presets to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_sparkclusters_resource_presets_get

Get DataLens Spark resource preset · read-only

One resource preset: its cores and its memory. Experimental API, not measured.

Parameter Type Required Description
resource_preset_id string yes Resource preset id.
cloud_environment_id string yes The cloud environment the presets are for.

datalens_htmlpages_get

Get DataLens HTML page · read-only

One HTML page: where it lies and its revisions.

The reply has no HTML of the page; htmlpages_preview_url_get gives a link that shows it. entries_list with the scope artifact finds the pages.

Parameter Type Required Description
entry_id string yes Entry id.
rev_id string or null One revision, as it is; give it or branch, not both.
branch saved · published or string or null The version to read when no revision is named: saved or published.
include_permissions boolean or null Also say what the caller may do with it.
include_favorite boolean or null Also say whether the page is a favourite.

datalens_htmlpages_create

Create DataLens HTML page · write

Create an HTML page; the reply has it under entry and warnings about its HTML.

Creating publishes: the page is saved and published at once. A draft comes with the first htmlpages_update with mode="save".

Parameter Type Required Description
content string yes The HTML of the page.
annotation object or null A description of the page.
key string or null The page's key, in a folder.
workbook_id string or null The workbook to create the page in.
name string or null The page's name, in a workbook.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_htmlpages_update

Update DataLens HTML page · idempotent write

Save new HTML of a page, or make one of its revisions the current one.

mode save makes a new revision and leaves the public one; publish shows it to everyone. With revId, save copies that revision as the current draft.

Parameter Type Required Description
body object or object yes Either new HTML, {entryId, content, mode}, or a revision to make current, {entryId, revId, mode}: one of the two, not both.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_htmlpages_delete

Delete DataLens HTML page · destructive write

Delete an HTML page.

Parameter Type Required Description
entry_id string yes Entry id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_htmlpages_preview_url_get

Get a preview link of a DataLens HTML page · read-only

A temporary signed link that shows the page; it stops working after a while.

Parameter Type Required Description
entry_id string yes Entry id.
branch saved · published or string or null The version to read when no revision is named: saved or published.
rev_id string or null One revision, as it is; give it or branch, not both.
lang en · ru or string or null Language of the preview: en or ru.
theme light · dark · light-hc · dark-hc · system or string or null Theme of the preview.

datalens_members_list

List DataLens members · read-only

The users, groups and service accounts of the organization, auto-paginated.

The sub of a member is the subject id a role is given to: find it here before collections_access_bindings_update or workbooks_access_bindings_update. Capped at the configured item cap unless limit is given.

Parameter Type Required Description
limit integer or null Max members to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
language en · ru or string or null Language of the names.
search string or null Keep the members whose name or address has this text.
tab_id SUBJECT_TYPE_UNSPECIFIED · USER_ACCOUNT · GROUP · INVITEE · SERVICE_ACCOUNT · _system or string or null Keep one kind of subject.
filter string or null A filter expression of the API.

datalens_entries_list

Find DataLens entries · read-only

Entries across the whole organization: dashboards, charts, datasets, connections.

The API requires one of scope, scopes and ids. An entry the caller may not read comes with isLocked set and little else. Auto-paginated; capped at the configured item cap unless limit is given.

Parameter Type Required Description
limit integer or null Max entries to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
ids array of string or null Keep the entries with these ids.
scope dash · report · widget · dataset · folder · connection · compute · artifact · sql_query or string or null Keep one kind of entry.
scopes array of dash · report · widget · dataset · folder · connection · compute · artifact · sql_query or string or null Keep several kinds of entries.
type array of string or null Keep these types of entries.
created_by array of string or null Keep what these users created.
order_by object or null What to sort by and in which direction.
exclude_locked boolean or null Leave out the entries the caller may not read.
include_links boolean or null Also say what each entry is linked to.
filters object or null Keep the entries whose name has a text.
include_permissions_info boolean or null Also say what the caller may do with it.
ignore_workbook_entries boolean or null Leave out the entries that lie in workbooks.
ignore_shared_entries boolean or null Leave out the shared entries.
include_data boolean or null Also give the content of each entry (large).

datalens_entries_relations_list

List what DataLens entries use or are used by · read-only

What entries use (a chart's dataset, a dataset's connection) or what uses them.

Use it before changing or deleting an entry, to see what depends on it. Auto-paginated.

Parameter Type Required Description
entry_ids array of string yes Entry ids.
limit integer or null Max relations to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
link_direction string or null from: what the entries use; to: what uses them.
include_permissions_info boolean or null Also say what the caller may do with it.
scope dash · report · widget · dataset · folder · connection · compute · artifact · sql_query or string or null Keep one kind of related entry.

datalens_entries_permissions_get

Get DataLens permissions on entries · read-only

What the caller may do with each entry, as a map by id.

An entry that does not exist gives error: "NOT_FOUND" under its id.

Parameter Type Required Description
entry_ids array of string yes Entry ids.

datalens_entries_revisions_list

List DataLens entry revisions · read-only

The revisions of an entry: who saved it and when. Auto-paginated.

Parameter Type Required Description
entry_id string yes Entry id.
limit integer or null Max revisions to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
rev_ids array of string or null Keep only these revisions.

datalens_entries_rename

Rename DataLens entry · idempotent write

Give an entry another name; its id and what refers to it stay.

Parameter Type Required Description
entry_id string yes Entry id.
name string yes The new name.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_permissions_get_bulk

Get DataLens permissions on many objects · read-only

What the caller may do with many entries, workbooks and collections, in one call.

Each of the three maps is keyed by id: an object the caller can see gives permissions, one that does not exist gives error: "NOT_FOUND".

Parameter Type Required Description
entry_ids array of string or null Ids of entries.
workbook_ids array of string or null Ids of workbooks.
collection_ids array of string or null Ids of collections.

datalens_connections_get

Get DataLens connection · read-only

One connection by id: its name, its kind and the settings of that kind.

The kind comes in db_type: the reply has no type, though creating one takes it.

A password or a token is never in the reply. workbooks_entries_list with the scope connection finds the connections of a workbook.

Parameter Type Required Description
connection_id string yes Connection id.
workbook_id string or null The workbook the connection lies in.
binded_dataset_id string or null A dataset bound to the connection, to read it through.
rev_id string or null The revision to read; the current one when left out.

datalens_connections_create

Create DataLens connection · write

Create a connection and return its id.

Give workbook_id (or dir_path) for where it lies. The password or the token you give is stored by DataLens and never returned by connections_get. A connection to Google Sheets (gsheets) cannot be created here: the API answers that the type is not editable; it is made in the DataLens interface and then read like any other.

Parameter Type Required Description
connection object yes The new connection; type says which kind it is and selects its schema. Its schema is not listed here: read ConnectionCreate with schema_get(service="datalens", name="ConnectionCreate"), then the definitions it refers to.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_connections_update

Update DataLens connection · idempotent write

Change the fields given of a connection; returns an acknowledgement.

Parameter Type Required Description
connection_id string yes Connection id.
data object yes The fields to change, of the connection's own kind; the others stay as they are. Its schema is not listed here: read ConnectionUpdate with schema_get(service="datalens", name="ConnectionUpdate"), then the definitions it refers to.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_connections_delete

Delete DataLens connection · destructive write

Delete a connection; the datasets built on it lose their source.

The API has no way to bring it back, and a chart that reads through it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Parameter Type Required Description
connection_id string yes Connection id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_datasets_get

Get DataLens dataset · read-only

One dataset by id: its sources, their joins and its fields.

dataset.result_schema lists the fields with their guids, which datasets_data_get takes as columns. A source or a field of a kind this server does not know comes as it is.

Parameter Type Required Description
dataset_id string yes Dataset id.
workbook_id string or null The workbook the dataset lies in.
rev_id string or null The revision to read; the current one when left out.

datalens_datasets_create

Create DataLens dataset · write

Create a dataset in a workbook and return it with its id.

A dataset with no source and no field is valid: create it empty, then fill it with datasets_update.

Parameter Type Required Description
dataset object yes What the dataset holds: sources, their joins, fields. An empty one is valid. Its schema is not listed here: read DatasetContent with schema_get(service="datalens", name="DatasetContent"), then the definitions it refers to.
collection_id string or null The collection to create it in.
created_via string or null How it is created: user or workbook_copy.
dir_path string or null The folder to create it in (old placement model).
name string or null The dataset's name.
options object or null What the editor may do with it.
preview boolean or null Whether it is a preview.
published_id string or null The published revision.
rev_id string or null The revision.
saved_id string or null The saved revision.
workbook_id string or null The workbook to create it in.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_datasets_update

Update DataLens dataset · idempotent write

Save a dataset as given: read it, change what it holds, send it back whole.

data.dataset replaces the content. Check a change first with datasets_validate. Read the dataset again after every save: content of an older revision is refused. The reply holds the content and the revisions; its id is null (measured).

Parameter Type Required Description
dataset_id string yes Dataset id.
data object yes The content to save (dataset) and how (mode: save or publish). Its schema is not listed here: read DatasetUpdate with schema_get(service="datalens", name="DatasetUpdate"), then the definitions it refers to.
workbook_id string or null The workbook the dataset lies in.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_datasets_delete

Delete DataLens dataset · destructive write

Delete a dataset; the charts built on it lose their data.

The API has no way to bring it back, and a chart built on it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Parameter Type Required Description
dataset_id string yes Dataset id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_datasets_validate

Validate DataLens dataset · read-only

Check a dataset, or changes to it, without saving anything.

The reply is the dataset as it would be, with code, message and dataset_errors. Give the content as last read: after a save, content of an older revision is refused.

Parameter Type Required Description
dataset_id string yes Dataset id.
data object yes The content to check (dataset) and the changes to try on it (updates). Its schema is not listed here: read DatasetValidate with schema_get(service="datalens", name="DatasetValidate"), then the definitions it refers to.
workbook_id string or null The workbook the dataset lies in.
binded_dataset_id string or null A dataset bound to this one.

datalens_datasets_data_get

Read rows of a DataLens dataset · read-only

Rows of a dataset: the columns asked for, one page per call.

Columns are named by the guid of a field, not by its title: read them with datasets_get. For the next page give offset together with sort.

Parameter Type Required Description
dataset_id string yes Dataset id.
columns array of string yes The guids of the fields to return (dataset.result_schema[].guid).
workbook_id string or null The workbook the dataset lies in.
filters array of object or null The rows to keep: a field's guid, an operation and its values.
params array of object or null Values for the dataset's parameters.
sort array of object or null The order of the rows: a field's guid and asc or desc.
limit integer or null The most rows to return; 100 when left out.
offset integer or null How many rows to skip; above zero it needs sort.

datalens_charts_data_get

Read the data of a DataLens chart · read-only

The data a saved chart shows, as tables of columns and rows.

The chart runs with its saved settings. chartType says how it is built (wizard, ql, editor). A pivot table is not supported, and a chart whose source cannot be reached answers with an error. A chart of the editor with no source did not answer within the client's wait: the call ends with a timeout after about two minutes (measured, twice). entries_list with the scope widget finds charts.

Parameter Type Required Description
chart_id string yes Chart id.
params object or null Values for the chart's parameters, by name: one value or several.

datalens_charts_wizard_get

Get DataLens wizard chart · read-only

One chart built in the wizard: the datasets it reads and what it shows.

entry.data is what charts_wizard_update takes back; isFavorite and permissions come only when asked for. entries_list with the scope widget finds charts; its type says how a chart is built.

Parameter Type Required Description
chart_id string yes Chart id.
workbook_id string or null The workbook the chart lies in.
rev_id string or null One revision to read, as it is; give it or branch, not both.
include_permissions boolean or null Also say what the caller may do with it.
include_links boolean or null Also say what it is linked to.
include_favorite boolean or null Also say whether it is a favourite of the caller.
branch saved · published or string or null The version to read when no revision is named: saved or published. A save writes the saved one: read saved before changing a chart.

datalens_charts_wizard_create

Create DataLens wizard chart · write

Create a chart of the wizard in a workbook and return it with its id.

The entry.data of a chart read with charts_wizard_get is a valid data.

Parameter Type Required Description
data object yes What the chart holds: sources and visualization. Its schema is not listed here: read WizardChartData with schema_get(service="datalens", name="WizardChartData"), then the definitions it refers to.
annotation object or null A description of the chart.
key string or null The entry's key, in a folder.
workbook_id string or null The workbook to create it in.
name string or null The chart's name.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_wizard_update

Update DataLens wizard chart · idempotent write

Save a chart of the wizard as given: read it, change it, send it back whole.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Parameter Type Required Description
chart_id string yes Chart id.
mode save · publish or string yes save keeps a draft; publish makes it the version shown.
data object yes What the chart holds; it replaces the whole of it. Its schema is not listed here: read WizardChartData with schema_get(service="datalens", name="WizardChartData"), then the definitions it refers to.
annotation object or null A description of the chart.
rev_id string or null The revision the change is made on; DataLens does not check it (measured).
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_wizard_delete

Delete DataLens wizard chart · destructive write

Delete a chart; the dashboards that show it lose it.

The API has no way to bring it back, and a dashboard that shows it keeps naming its id (measured).

The interface lists what was deleted under Service settings, Deleted objects, with a Restore button (measured: the entry appears there; restoring was not tried).

Parameter Type Required Description
chart_id string yes Chart id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_ql_get

Get DataLens QL chart · read-only

One QL chart. Unlike a chart of the wizard it comes flat, with no entry around it.

Parameter Type Required Description
chart_id string yes Chart id.
workbook_id string or null The workbook the chart lies in.
rev_id string or null One revision to read, as it is; give it or branch, not both.
include_permissions boolean or null Also say what the caller may do with it.
include_links boolean or null Also say what it is linked to.
include_favorite boolean or null Also say whether it is a favourite of the caller.
branch saved · published or string or null The version to read when no revision is named: saved or published. A save writes the saved one: read saved before changing a chart.

datalens_charts_ql_create

Create DataLens QL chart · write

Create a QL chart; the reply is what DataLens answers, as it came.

The specification describes neither the content of a QL chart nor the reply.

Parameter Type Required Description
template string yes The template of the chart; the API takes only ql today.
data object yes What the chart holds: its query and how it is shown.
annotation object or null A description of the chart.
key string or null The entry's key, in a folder.
workbook_id string or null The workbook to create it in.
name string or null The chart's name.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_ql_update

Update DataLens QL chart · idempotent write

Save a QL chart as given; the reply is what DataLens answers, as it came.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Parameter Type Required Description
entry_id string yes Chart id.
template string yes The template of the chart; the API takes only ql today.
mode save · publish or string yes save keeps a draft; publish makes it the version shown.
data object yes What the chart holds; it replaces the whole of it.
annotation object or null A description of the chart.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_ql_delete

Delete DataLens QL chart · destructive write

Delete a chart; the dashboards that show it lose it.

Parameter Type Required Description
chart_id string yes Chart id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_editor_get

Get DataLens editor chart · read-only

One chart written in the editor: its kind (entry.type) and its tabs of code.

Parameter Type Required Description
chart_id string yes Chart id.
workbook_id string or null The workbook the chart lies in.
rev_id string or null One revision to read, as it is; give it or branch, not both.
include_permissions boolean or null Also say what the caller may do with it.
include_links boolean or null Also say what it is linked to.
include_favorite boolean or null Also say whether it is a favourite of the caller.
branch saved · published or string or null The version to read when no revision is named: saved or published. A save writes the saved one: read saved before changing a chart.

datalens_charts_editor_create

Create DataLens editor chart · write

Create a chart of the editor and return it with its id.

Parameter Type Required Description
entry object or object or object or object or object or object yes The new chart: where it lies, its kind (type) and its code.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_editor_update

Update DataLens editor chart · idempotent write

Save a chart of the editor as given.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Parameter Type Required Description
entry object or object or object or object or object or object yes The chart to save: its entryId, its kind (type) and its code.
mode save · publish or string yes save keeps a draft; publish makes it the version shown.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_charts_editor_delete

Delete DataLens editor chart · destructive write

Delete a chart; the dashboards that show it lose it.

Parameter Type Required Description
chart_id string yes Chart id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_dashboards_get

Get DataLens dashboard · read-only

One dashboard: its tabs and the charts, selectors and texts on them.

A real dashboard is large, 100 KB and more, which may be over what a client shows of a tool's reply: read a big one as a file (ycli datalens dashboards get <id> > dash.json). entry.data is what dashboards_update takes back.

Parameter Type Required Description
dashboard_id string yes Dashboard id.
rev_id string or null One revision to read, as it is; give it or branch, not both.
include_permissions boolean or null Also say what the caller may do with it.
include_links boolean or null Also say what the dashboard is linked to.
include_favorite boolean or null Also say whether the dashboard is a favourite.
branch saved · published or string or null The version to read when no revision is named: saved or published. A save writes the saved one: read saved before changing a dashboard.
workbook_id string or null The workbook the dashboard lies in.

datalens_dashboards_create

Create DataLens dashboard · write

Create a dashboard and return it with its id.

data needs counter, salt, settings and tabs; a tab may be empty. entry.meta must be an object, {} when empty: without it DataLens answers 400 entry.meta: expected record, received undefined.

Parameter Type Required Description
entry object yes The new dashboard: where it lies (workbookId, name), data and meta. Its schema is not listed here: read DashboardCreate with schema_get(service="datalens", name="DashboardCreate"), then the definitions it refers to.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_dashboards_update

Update DataLens dashboard · idempotent write

Save a dashboard as given: read it, change data, send it back whole.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Parameter Type Required Description
entry object yes The dashboard to save: its entryId, data, meta and revId. Its schema is not listed here: read DashboardUpdate with schema_get(service="datalens", name="DashboardUpdate"), then the definitions it refers to.
mode save · publish or string yes save keeps the dashboard as a draft; publish shows it to all.
lock_token string or null The token of the lock held on the dashboard, when it is locked.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_dashboards_delete

Delete DataLens dashboard · destructive write

Delete a dashboard.

Parameter Type Required Description
dashboard_id string yes Dashboard id.
lock_token string or null The token of the lock held on the dashboard, when it is locked.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_reports_get

Get DataLens report · read-only

One report: its slides and the charts and texts on them.

entry.data and entry.meta are what reports_update takes back. entries_list with the scope report finds reports. A report has no branch in the API: the read answers the saved version (measured).

Parameter Type Required Description
entry_id string yes Report id.
rev_id string or null The revision of the report to read; the current when left out.
include_permissions boolean or null Also say what the caller may do with it.
include_favorite boolean or null Also say whether the report is a favourite.

datalens_reports_create

Create DataLens report · write

Create a report in a workbook; the API keeps no layout of slide elements.

Measured (2026-10-06): a report made through the API loses the layout of the elements of its slides and part of its settings, so a copy of a report read with reports_get loses where its elements stood. Say so before making one. DataLens refuses a report with no slide: data.slides holds at least one.

Parameter Type Required Description
data object yes What the report holds: its slides and its settings; it replaces the whole of it. Its schema is not listed here: read ReportData with schema_get(service="datalens", name="ReportData"), then the definitions it refers to.
meta object or null or null yes Metadata of the entry; null for none. Required.
annotation object or null A description of the report.
include_permissions boolean or null Also say what the caller may do with the new report.
key string or null The report's key, in a folder.
workbook_id string or null The workbook to create the report in.
name string or null The report's name.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_reports_update

Update DataLens report · idempotent write

Save a report; it LOSES the layout of its slide elements and some settings.

DataLens does not check a revision here: a save overwrites what was saved since you read it (measured).

Measured (2026-10-06): DataLens drops them on a save through the API, without a word, though every value is sent. Ask the person before saving an existing report. Otherwise: read it, change data, send it back whole.

Parameter Type Required Description
entry_id string yes Report id.
data object yes What the report holds: its slides and its settings; it replaces the whole of it. Its schema is not listed here: read ReportData with schema_get(service="datalens", name="ReportData"), then the definitions it refers to.
mode save · publish or string yes save keeps the report as a draft; publish shows it to all.
meta object or null or null yes Metadata of the entry; null for none. Required.
rev_id string or null The revision of the report the change is made on.
annotation object or null A description of the report.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_reports_delete

Delete DataLens report · destructive write

Delete a report.

Parameter Type Required Description
entry_id string yes Report id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbookexports_start

Start DataLens workbook export · write

Start exporting a workbook and return the id of the export.

The export runs on its own: ask workbookexports_status_get until status is success, then workbookexports_result_get for the document.

Parameter Type Required Description
workbook_id string yes Workbook id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbookexports_status_get

Get DataLens workbook export status · read-only

How far an export is: pending, success or error, and the progress in percent.

notifications holds what the export has to say about an entry: id, level, message.

Parameter Type Required Description
export_id string yes Export id, from workbookexports_start.

datalens_workbookexports_result_get

Get DataLens workbook export result · read-only

The exported workbook: every entry it holds, as one document.

data is what workbookimports_start takes. An export that is not over, or was cancelled, answers 409 Conflict. The document is large (hundreds of kilobytes for a workbook with a dashboard) and holds no password or token of a connection.

Parameter Type Required Description
export_id string yes Export id, from workbookexports_start.

datalens_workbookexports_cancel

Cancel DataLens workbook export · idempotent write

Stop an export: its status becomes error, with WORKBOOK_EXPORT_CANCELLED.

An export that is over stays as it ended, and the call answers the same.

Parameter Type Required Description
export_id string yes Export id, from workbookexports_start.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbookimports_start

Start DataLens workbook import · write

Start making a workbook from an export; returns the ids of the import and the workbook.

The workbook exists at once and is filled as the import runs: ask workbookimports_status_get until status is success. Its connections come without their secrets (a notification …CONN.CHECK_CREDENTIALS says so): give each its password or token again with connections_update.

Parameter Type Required Description
data object yes The data of workbookexports_result_get: export, hash.
title string yes The title of the new workbook.
collection_id string or null The collection to make it in; the root when left out.
description string or null The description of the new workbook.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_workbookimports_status_get

Get DataLens workbook import status · read-only

How far an import is: pending, success or error, and the progress in percent.

notifications holds what the import has to say about an entry: id, level, message.

Parameter Type Required Description
import_id string yes Import id, from workbookimports_start.

datalens_embeds_list

List DataLens embeds · read-only

The embeds of one entry: where a chart or a dashboard is shown on another site.

Parameter Type Required Description
entry_id string yes The id of the entry that is embedded.

datalens_embeds_create

Create DataLens embed · write

Embed an entry and return the embed.

The key for embedding is one of the workbook the entry lies in (embeddingsecrets_list).

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
title string yes The name of the embed.
embedding_secret_id string yes The key for embedding that signs its links.
entry_id string yes The entry to embed.
public_params_mode boolean yes Whether the default mode of parameters is on.
settings object yes The settings of the embed; an empty object is valid.
deps_ids array of string or null The entries the embedded one depends on.
unsigned_params array of string or null The parameters a link may carry unsigned.
private_params array of string or null The parameters that go signed, inside the token.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_embeds_update

Update DataLens embed · idempotent write

Save an embed as given and return it.

The embed is replaced whole: read it with embeds_list and send back what is to stay; a list left out is saved empty.

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
embed_id string yes Embed id, from embeds_list.
title string yes The name of the embed.
embedding_secret_id string yes The key for embedding that signs its links.
public_params_mode boolean yes Whether the default mode of parameters is on.
settings object yes The settings of the embed; an empty object is valid.
deps_ids array of string or null The entries the embedded one depends on.
unsigned_params array of string or null The parameters a link may carry unsigned.
private_params array of string or null The parameters that go signed, inside the token.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_embeds_delete

Delete DataLens embed · destructive write

Delete an embed; its links stop working. Deleting again answers 404.

Parameter Type Required Description
embed_id string yes Embed id, from embeds_list.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_embeddingsecrets_get

Get DataLens key for embedding · read-only

One key for embedding: its name, its workbook, who made it. Never its private key.

Parameter Type Required Description
embedding_secret_id string yes Id of the key for embedding.

datalens_embeddingsecrets_list

List DataLens keys for embedding · read-only

The keys for embedding of a workbook, without their private keys.

Parameter Type Required Description
workbook_id string yes Workbook id.

datalens_embeddingsecrets_create

Create DataLens key for embedding · write

Make a key for embedding and return its id and its private key.

The private key is given once: embeddingsecrets_get and embeddingsecrets_list do not return it. It comes in this tool's result, so it enters your context: hand it to the person at once, and do not repeat it in later messages.

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
title string yes The name of the key.
workbook_id string yes The workbook the key belongs to.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_embeddingsecrets_delete

Delete DataLens key for embedding · destructive write

Delete a key for embedding. Deleting again answers 404.

Parameter Type Required Description
embedding_secret_id string yes Id of the key for embedding.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sharedentries_access_bindings_list

List the roles on a DataLens shared entry · read-only

Who has which role on a shared entry, auto-paginated.

An entry that lies in a workbook, or an id nothing knows, answers an empty list.

Parameter Type Required Description
entry_id string yes Id of a shared entry: one that lies in a collection.
limit integer or null Max subjects to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.
get_inherited_bindings boolean or null Also list the roles inherited from above.

datalens_sharedentries_access_bindings_update

Change the roles on a DataLens shared entry · write

Give or take away roles on a shared entry; the roles not named stay as they are.

The roles are datalens.sharedEntries.* (viewer, admin, …).

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
entry_id string yes Id of a shared entry: one that lies in a collection.
deltas array of object yes The roles to add (ADD) and remove.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_audit_entries_updates_list

List DataLens entries changed in a period · read-only

The entries changed in a period, auto-paginated: what, when and by whom.

A deleted entry is listed too, with isDeleted.

Parameter Type Required Description
from_ string yes The start of the period: an ISO-8601 time with its zone.
to string or null The end of the period.
limit integer or null Max entries to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_audit_entry_permissions_get

Get a user's permissions on DataLens entries · read-only

What one user may do with each entry: execute, read, edit, admin, by entry id.

Parameter Type Required Description
entry_ids array of string yes The ids of the entries to ask about.
user_id string yes The user's id, as createdBy of an entry gives it.

datalens_sqlqueries_get

Get DataLens saved SQL query · read-only

One saved SQL query: its text, its connection and its parameters.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

Parameter Type Required Description
sql_query_id string yes SQL query id.
rev_id string or null The revision to read; the current one when left out.
include_permissions boolean or null Also say what the caller may do with it.
include_favorite boolean or null Also say whether it is a favourite.

datalens_sqlqueries_create

Create DataLens saved SQL query · write

Save a SQL query in a workbook and return it.

Experimental in the DataLens API and written from its document: not measured. An organization whose SQL editor is off answers 403 SQL_EDITOR_NOT_ALLOWED.

Parameter Type Required Description
workbook_id string yes The workbook to keep it in.
name string yes The query's name in the workbook.
connection_id string yes The connection it runs over: PostgreSQL, ClickHouse, MySQL, Greenplum, Trino.
query string yes The text of the query.
description string or null A description.
params array of object or object or object or null The parameters the text takes: a name, a type and a default each.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sqlqueries_update

Update DataLens saved SQL query · idempotent write

Save a SQL query anew and return it; the connection and the text go every time.

Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
sql_query_id string yes SQL query id.
connection_id string yes The connection it runs over: PostgreSQL, ClickHouse, MySQL, Greenplum, Trino.
query string yes The text of the query.
description string or null A description.
params array of object or object or object or null The parameters the text takes.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sqlqueries_delete

Delete DataLens saved SQL query · destructive write

Delete a saved SQL query.

Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
sql_query_id string yes SQL query id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sqlqueries_run

Run DataLens saved SQL query · write

Run a saved SQL query on its connection and return the result of each statement.

The text runs as it is saved: one that changes data changes it. Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
sql_query_id string yes SQL query id.
params object or null The values of the parameters, by name; one left out takes its default.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_licensing_licenses_list

List DataLens licences · read-only

The licences (seats) of the DataLens instance, auto-paginated.

Each says whose it is, its type (creator or viewer), whether it is active, and when its holder last signed in.

Parameter Type Required Description
user_ids array of string or null Only the licences of these users.
status active · expired · expiring or string or null Only the licences in this state.
sort_by createdAt · updatedAt or string or null The field to sort by.
order asc · desc or string or null The order of the sort.
limit integer or null Max licences to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_licensing_licenses_assign

Assign DataLens licences · write

Give each of these users a licence and return the licences given.

A licence is a seat DataLens bills for: ask the person before calling. Written from the DataLens document and never called: not measured.

Grants access: a client that honours the mark asks a person on every call.

Parameter Type Required Description
user_ids array of string yes The users to give a licence to.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_licensing_limit_get

Get DataLens licence limit · read-only

How many licences the instance may hold: the limit in force and the one that takes over.

current carries the count of active licences; next is null when no change is set.

datalens_licensing_limit_set

Set DataLens licence limit · idempotent write

Set how many licences the instance may hold and return the limits.

The limit is the number of seats DataLens bills for: ask the person before calling. Written from the DataLens document and never called: not measured.

Parameter Type Required Description
value integer yes The most licences the instance may hold.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_cloudenvironments_list

List DataLens cloud environments · read-only

The cloud environments of the DataLens instance, auto-paginated.

Experimental in the DataLens API. An instance with none answers an empty list.

Parameter Type Required Description
filter array of string or null Conditions, all of which must hold; each is field="value" over name, cloud_id, status or created_by_id.
include_permissions boolean or null Also say what the caller may do with it.
limit integer or null Max environments to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_cloudenvironments_get

Get DataLens cloud environment · read-only

One cloud environment: its cloud, its subnet, its status and its storage.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404: it is not a lack of rights.

Parameter Type Required Description
id string yes Id of the cloud environment.
include_permissions boolean or null Also say what the caller may do with it.

datalens_cloudenvironments_create

Create DataLens cloud environment · write

Make a cloud environment and return the operation that makes it.

It creates resources in a cloud, which may be billed: ask the person before calling. Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
name string yes The environment's name.
cloud_id string yes The cloud to make it in.
subnet_id string yes The subnet it uses.
description string or null A description.
security_group_ids array of string or null The security groups the environment uses.
storage object or null The settings of its storage bucket; no bucket when left out.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_cloudenvironments_update

Update DataLens cloud environment · idempotent write

Change the fields given of a cloud environment and return the operation.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
id string yes Id of the cloud environment.
name string or null A new name.
description string or null A new description; an empty one clears it.
security_group_ids array of string or null The security groups the environment uses.
storage object or null New settings of its storage bucket.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_cloudenvironments_delete

Delete DataLens cloud environment · destructive write

Delete a cloud environment and return the operation that deletes it.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
id string yes Id of the cloud environment.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_cloudenvironmentstorage_bucket_objects_list

List the objects of a DataLens storage bucket · read-only

The paths of the objects in a cloud environment's storage bucket, auto-paginated.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied, not 404: it is not a lack of rights.

Parameter Type Required Description
cloud_environment_id string yes Id of the cloud environment the bucket belongs to.
prefix string or null Only the paths that start with this.
limit integer or null Max paths to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_cloudenvironmentstorage_bucket_object_metadata_get

Get the metadata of a DataLens bucket object · read-only

The size of an object, in bytes as a string, and when it last changed.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied, not 404.

Parameter Type Required Description
cloud_environment_id string yes Id of the cloud environment the bucket belongs to.
path string yes The path of the object in the bucket.

datalens_cloudenvironmentstorage_bucket_download_url_create

Create a download link for a DataLens bucket object · read-only

A signed link to read one object of the bucket.

The link works for whoever holds it, for a time, and it comes in this tool's result: hand it to the person and do not repeat it. Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
cloud_environment_id string yes Id of the cloud environment the bucket belongs to.
path string yes The path of the object in the bucket.

datalens_cloudenvironmentstorage_bucket_upload_url_create

Create an upload link for a DataLens bucket object · write

A signed link to put one object into the bucket.

The link works for whoever holds it, for a time, and it comes in this tool's result: hand it to the person and do not repeat it. Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
cloud_environment_id string yes Id of the cloud environment the bucket belongs to.
path string yes The path of the object in the bucket.
size string yes The size of the object in bytes, as a string.
content_md5 string yes The MD5 digest of the content: 16 bytes, base64-encoded.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_restcatalogs_list

List DataLens REST catalogs · read-only

The REST catalogs of the DataLens instance, auto-paginated.

Experimental in the DataLens API. An instance with none answers an empty list.

Parameter Type Required Description
cloud_environment_id string or null Only the catalogs of this cloud environment.
filter array of string or null Conditions such as name="…"; only matching catalogs are kept.
sort_by name · createdAt · updatedAt or string or null The field to sort by.
reverse_order boolean or null Sort the other way round.
include_permissions boolean or null Also say what the caller may do with it.
limit integer or null Max catalogs to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_restcatalogs_create

Create DataLens REST catalog · write

Make a REST catalog and return the operation that makes it.

It creates a bucket in a cloud, which may be billed: ask the person before calling. Ask lakehouseoperations_get for the operation until done. Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cloud_environment_id string yes The cloud environment to make it in.
name string yes The catalog's name.
bucket_settings object yes The settings of its bucket; an empty object is valid.
description string or null A description.
labels object or null Labels, a name to a value.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_lakehouseoperations_get

Get DataLens Lakehouse operation · read-only

How far an operation is: done or not, and then its error or its response.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404: it is not a lack of rights.

Parameter Type Required Description
operation_id string yes Operation id, from making a cloud environment or a REST catalog.

datalens_trinoclusters_list

List DataLens Trino clusters · read-only

The Trino clusters of the DataLens instance, auto-paginated.

Experimental in the DataLens API. An instance with none answers an empty list.

Parameter Type Required Description
filter array of string or null Conditions the clusters must meet.
collection_id string or null Only the clusters of this collection.
catalog_id string or null Only the clusters this REST catalog is attached to.
limit integer or null Max clusters to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_trinoclusters_get

Get DataLens Trino cluster · read-only

One Trino cluster: its configuration, its health, its status and its coordinator.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404: it is not a lack of rights.

Parameter Type Required Description
id string yes Id of the Trino cluster.

datalens_trinoclusters_create

Create DataLens Trino cluster · write

Make a Trino cluster and return the operation that makes it.

A cluster is cloud resources, billed while it runs: ask the person before calling. Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
collection_id string yes The DataLens collection to make it in.
cloud_environment_id string yes The cloud environment to make it in.
name string yes The cluster's name.
worker_config object yes The workers: their resource preset and how many there may be.
description string or null A description.
labels object or null Labels, a name to a value.
catalogs_config array of object or null The REST catalogs to attach.
trino_version string or null The version of Trino; the service's own when left out.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_delete

Delete DataLens Trino cluster · destructive write

Delete a Trino cluster and return the operation that deletes it.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
id string yes Id of the Trino cluster.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_start

Start DataLens Trino cluster · write

Start a stopped Trino cluster and return the operation that starts it.

A running cluster is billed: ask the person before calling. Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Trino cluster.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_stop

Stop DataLens Trino cluster · write

Stop a running Trino cluster and return the operation that stops it.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Trino cluster.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_catalog_create

Attach a REST catalog to a DataLens Trino cluster · write

Attach a REST catalog to a Trino cluster and return the operation.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Trino cluster.
catalog object yes The REST catalog to attach, by its id.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_catalog_delete

Detach a REST catalog from a DataLens Trino cluster · destructive write

Detach a REST catalog from a Trino cluster; the catalog itself stays.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Trino cluster.
catalog_id string yes The id of the REST catalog to detach.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_trinoclusters_resource_presets_list

List DataLens Trino resource presets · read-only

The sizes a cluster's machines may have in a cloud environment, auto-paginated.

Experimental in the DataLens API and written from its document: not measured. An environment nothing knows answers 403 Permission denied, not 404.

Parameter Type Required Description
cloud_environment_id string yes The cloud environment the presets are of.
limit integer or null Max presets to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_trinoclusters_resource_preset_get

Get DataLens Trino resource preset · read-only

One size of a cluster's machines: its cores and its memory.

Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
resource_preset_id string yes Id of the resource preset.
cloud_environment_id string yes The cloud environment the presets are of.

datalens_sparkapplications_list

List DataLens Spark applications · read-only

The applications of a Spark cluster, auto-paginated.

Experimental in the DataLens API and written from its document: not measured. A cluster nothing knows answers 403 Permission denied, not 404: it is not a lack of rights.

Parameter Type Required Description
cluster_id string yes Id of the Spark cluster.
filter array of string or null Conditions, all of which must hold; each is field="value" over name, created_by, application_type or catalog_id.
limit integer or null Max applications to return; omitted means the configured cap of a tool (YCLI__HTTP__MAX_TOOL_ITEMS).
all boolean Return everything, ignoring the cap. A long listing is better taken in pieces: limit, then next.
next string or null Go on from where an earlier call stopped, with the next it returned: the token carries its listing; give what is required again, and nothing else but the limit.

datalens_sparkapplications_get

Get DataLens Spark application · read-only

One Spark application: its status, its times and what it runs.

Experimental in the DataLens API and written from its document: not measured. An id nothing knows answers 403 Permission denied, not 404.

Parameter Type Required Description
cluster_id string yes Id of the Spark cluster.
application_id string yes Id of the Spark application.

datalens_sparkapplications_create

Create DataLens Spark application · write

Make a Spark application on a cluster and return the operation that makes it.

Experimental in the DataLens API, written from its document and never called: not measured. Ask the person before calling.

Parameter Type Required Description
body object or object or object yes The application to make: clusterId, a name, the catalogs to attach, and exactly one of sparkApplication (a JAR), pysparkApplication (a Python file) or sparkConnectApplication.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkapplications_cancel

Cancel DataLens Spark application · write

Stop a Spark application and return the operation that cancels it.

Experimental in the DataLens API, written from its document and never called: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Spark cluster.
application_id string yes Id of the Spark application.
dry_run boolean Send nothing: answer {dry_run: true, request}, the first write the tool would make (null: none).

datalens_sparkapplications_log_list

Read the log of a DataLens Spark application · read-only

One fragment of an application's log, and the token of the next one.

Give nextPageToken back as page_token to read on. Experimental in the DataLens API and written from its document: not measured.

Parameter Type Required Description
cluster_id string yes Id of the Spark cluster.
application_id string yes Id of the Spark application.
page_size integer or null The most characters the fragment may hold.
page_token string or null The token of the fragment to read; the first when left out.