DataLens API: 🚧 [Experimental] Create dashboard
HTTP request
Creates the specified dashboard.
POST https://api.datalens.yandex.net/rpc/createDashboard
Body parameters
Request schema: application/json
{
"key": "string",
"data": {
"counter": "integer",
"salt": "string",
"schemeVersion": "number",
"tabs": [
{
"id": "string",
"title": "string",
"items": [
{
"<allOf>": [
{
"id": "string",
"namespace": "string",
"type": "string"
},
"unknown"
]
}
],
"layout": [
{
"i": "string",
"h": "number",
"w": "number",
"x": "number",
"y": "number",
"parent": "string"
}
],
"connections": [
{
"from": "string",
"to": "string",
"kind": "string"
}
],
"aliases": {
"default": [
"array"
]
}
}
],
"settings": {
"autoupdateInterval": "unknown",
"maxConcurrentRequests": "unknown",
"loadPriority": "string",
"silentLoading": "boolean",
"dependentSelectors": "boolean",
"globalParams": {
"string": "unknown"
},
"hideTabs": "boolean",
"hideDashTitle": "boolean",
"expandTOC": "boolean",
"assistantEnabled": "boolean"
},
"supportDescription": "string",
"accessDescription": "string"
},
"meta": {
"string": "unknown"
},
"links": {
"string": "string"
},
"workbookId": "string",
"lockToken": "string",
"mode": "string"
}
|
Field |
Description |
|
key |
string Required field. Key of the dashboard entry. Indicates the path and name of the dashboard. |
|
data |
Required field. Dashboard data structure. |
|
meta |
object (map<string, unknown>) Metadata associated with the dashboard. |
|
links |
object (map<string, string>) Information about configured links on the dashboard. For details about dashboard links, see documentation. |
|
workbookId |
string ID of the workbook the dashboard belongs to. |
|
lockToken |
string |
|
mode |
enum Required field.
|
Data
Dashboard data structure.
|
Field |
Description |
|
counter |
integer Required field. Counter for the dashboard. |
|
salt |
string Required field. Salt used for data hashing. |
|
schemeVersion |
enum
|
|
tabs[] |
Required field. List of dashboard tabs. |
|
settings |
Required field. Dashboard settings. |
|
supportDescription |
string Description for the window before contacting support. |
|
accessDescription |
string Access error message for the dashboard. |
TabsItem
Information about dashboard tab.
|
Field |
Description |
|
id |
string Required field. ID of the dashboard tab. |
|
title |
string Required field. Title of the dashboard tab. |
|
items[] |
unknown Required field. List of tab items. |
|
layout[] |
Required field. Layout configuration for the tab. |
|
connections[] |
Required field. Connections used in tab items. |
|
aliases |
Required field. Aliases for the tab. |
LayoutItem
Layout configuration for the tab.
|
Field |
Description |
|
i |
string Required field. Identifier for the layout item. |
|
h |
number Required field. Height of the layout item. |
|
w |
number Required field. Width of the layout item. |
|
x |
number Required field. X coordinate of the layout item. |
|
y |
number Required field. Y coordinate of the layout item. |
|
parent |
string |
ConnectionsItem
|
Field |
Description |
|
from |
string Required field. |
|
to |
string Required field. |
|
kind |
enum Required field.
|
Aliases
|
Field |
Description |
|
default[] |
string |
Settings
Information about dashboard settings.
|
Field |
Description |
|
autoupdateInterval |
Any of number | null | null Auto-update interval setting. |
|
maxConcurrentRequests |
Any of number | null | null Maximum concurrent requests. |
|
loadPriority |
enum Widget display order on a mobile device:
|
|
silentLoading |
boolean Required field. Silent loading flag. |
|
dependentSelectors |
boolean Required field. Dependent selectors flag. |
|
globalParams |
object (map<string, unknown>) Global parameters. |
|
hideTabs |
boolean Required field. Hide tabs flag. |
|
hideDashTitle |
boolean |
|
expandTOC |
boolean Required field. Expand table of contents flag. |
|
assistantEnabled |
boolean Neuroanalyst enabled flag. |
Response
HTTP Code: 200
Response
Response schema: application/json
{
"key": "unknown",
"workbookId": "unknown",
"data": {
"counter": "integer",
"salt": "string",
"schemeVersion": "number",
"tabs": [
{
"id": "string",
"title": "string",
"items": [
{
"<allOf>": [
{
"id": "string",
"namespace": "string",
"type": "string"
},
"unknown"
]
}
],
"layout": [
{
"i": "string",
"h": "number",
"w": "number",
"x": "number",
"y": "number",
"parent": "string"
}
],
"connections": [
{
"from": "string",
"to": "string",
"kind": "string"
}
],
"aliases": {
"default": [
"array"
]
}
}
],
"settings": {
"autoupdateInterval": "unknown",
"maxConcurrentRequests": "unknown",
"loadPriority": "string",
"silentLoading": "boolean",
"dependentSelectors": "boolean",
"globalParams": {
"string": "unknown"
},
"hideTabs": "boolean",
"hideDashTitle": "boolean",
"expandTOC": "boolean",
"assistantEnabled": "boolean"
},
"supportDescription": "string",
"accessDescription": "string"
},
"meta": {
"string": "string"
},
"links": {
"string": "string"
},
"entryId": "string",
"scope": "string",
"public": "boolean",
"isFavorite": "boolean",
"createdAt": "string",
"createdBy": "string",
"updatedAt": "string",
"updatedBy": "string",
"revId": "string",
"savedId": "string",
"publishedId": "string",
"type": "string"
}
|
Field |
Description |
|
key |
Any of null | string | null Key of the dashboard entry. Indicates the path and name of the dashboard. |
|
workbookId |
Any of null | string | null ID of the workbook the dashboard belongs to. |
|
data |
Required field. Dashboard data structure. |
|
meta |
object (map<string, string>) Required field. Metadata associated with the dashboard. |
|
links |
object (map<string, string>) Information about configured links on the dashboard. For details about dashboard links, see documentation. |
|
entryId |
string Required field. Unique identifier of the dashboard entry. |
|
scope |
enum Required field. Type of the entry. For dashboards takes value:
|
|
public |
boolean Required field. Indicates if the dashboard is public. |
|
isFavorite |
boolean Required field. Indicates if the dashboard is marked as favorite. |
|
createdAt |
string Required field. Timestamp when the dashboard was created. |
|
createdBy |
string Required field. User who created the dashboard. |
|
updatedAt |
string Required field. Timestamp when the dashboard was last updated. |
|
updatedBy |
string Required field. User who last updated the dashboard. |
|
revId |
string Required field. Revision ID of the dashboard. |
|
savedId |
string Required field. ID of the saved version of the dashboard. |
|
publishedId |
string Required field. ID of the published version of the dashboard. |
|
type |
enum Required field.
|
Data
Dashboard data structure.
|
Field |
Description |
|
counter |
integer Required field. Counter for the dashboard. |
|
salt |
string Required field. Salt used for data hashing. |
|
schemeVersion |
enum
|
|
tabs[] |
Required field. List of dashboard tabs. |
|
settings |
Required field. Dashboard settings. |
|
supportDescription |
string Description for the window before contacting support. |
|
accessDescription |
string Access error message for the dashboard. |
TabsItem
|
Field |
Description |
|
id |
string Required field. ID of the dashboard tab. |
|
title |
string Required field. Title of the dashboard tab. |
|
items[] |
unknown Required field. List of tab items. |
|
layout[] |
Required field. Layout configuration for the tab. |
|
connections[] |
Required field. Connections used in tab items. |
|
aliases |
Required field. Aliases for the tab. |
LayoutItem
Layout configuration for the tab.
|
Field |
Description |
|
i |
string Required field. Identifier for the layout item. |
|
h |
number Required field. Height of the layout item. |
|
w |
number Required field. Width of the layout item. |
|
x |
number Required field. X coordinate of the layout item. |
|
y |
number Required field. Y coordinate of the layout item. |
|
parent |
string Parent item identifier. |
ConnectionsItem
|
Field |
Description |
|
from |
string Required field. |
|
to |
string Required field. |
|
kind |
enum Required field.
|
Aliases
|
Field |
Description |
|
default[] |
string |
Settings
Information about dashboard settings.
|
Field |
Description |
|
autoupdateInterval |
Any of number | null | null Auto-update interval setting. |
|
maxConcurrentRequests |
Any of number | null | null Maximum concurrent requests. |
|
loadPriority |
enum Widget display order on a mobile device:
|
|
silentLoading |
boolean Required field. Silent loading flag. |
|
dependentSelectors |
boolean Required field. Dependent selectors flag |
|
globalParams |
object (map<string, unknown>) Global parameters. |
|
hideTabs |
boolean Required field. Hide tabs flag. |
|
hideDashTitle |
boolean Hide dashboard title flag. |
|
expandTOC |
boolean Required field. Expand table of contents flag. |
|
assistantEnabled |
boolean Neuroanalyst enabled flag. |