Dashboards

class dataikuapi.dss.dashboard.DSSDashboard(client, project_key, dashboard_id)

A handle to interact with a dashboard on the DSS instance.

Important

Do not instantiate directly, use dataikuapi.dss.DSSProject.get_dashboard() instead

delete()

Delete the dashboard

get_settings()

Get the dashboard’s definition

Returns:

a handle to inspect the dashboard definition

Return type:

dataikuapi.dss.dashboard.DSSDashboardSettings

class dataikuapi.dss.dashboard.DSSDashboardSettings(client, settings)

Settings for a dashboard

Important

Do not instantiate directly, use dataikuapi.dss.dashboard.DSSDashboard.get_settings() instead

get_raw()

Gets all settings as a raw dictionary.

Returns:

the settings, as a dict. Fields are:

• projectKey and id : identify the dashboard

• name : name (label) of the dashboard

• owner : login of the owner of the dashboard

• listed : boolean indicating whether the dashboard is private or public (i.e. promoted)

• pages : definition of the different slides

• versionTag, creationTag, checklists, tags, customFields : common fields on DSS objects

Return type:

dict

save()

Save the settings to the dashboard

property id

Get the identifier of the dashboard

Note

The id is generated by DSS upon creation and random.

Return type:

string

property name

Get the name of the dashboard

Note

The name is user-provided and not necessarily unique.

Return type:

str

property listed

Get the boolean indicating whether the dashboard is private or public (i.e. promoted)

Return type:

bool

property owner

Get the login of the owner of the dashboard

Return type:

str

class dataikuapi.dss.dashboard.DSSDashboardListItem(client, data)

An item in a list of dashboards.

Important

Do not instantiate this class, use dataikuapi.dss.project.DSSProject.list_dashboards()

to_dashboard()

Get a handle to interact with this dashboard

Returns:

a handle on the dashboard

Return type:

dataikuapi.dss.dashboard.DSSDashboard

property id

Get the identifier of the dashboard

Note

The id is generated by DSS upon creation and random.

Return type:

string

property name

Get the name of the dashboard

Note

The name is user-provided and not necessarily unique.

Return type:

str

property listed

Get the boolean indicating whether the dashboard is private or public (i.e. promoted)

Return type:

bool

property owner

Get the login of the owner of the dashboard

Return type:

str

property num_pages

Get the number of pages (i.e. slides) in the dashboard

Return type:

int

property num_tiles

Get the number of tiles in the dashboard

Return type:

int