Insights#

class dataikuapi.dss.insight.DSSInsight(client, project_key, insight_id)#

A handle to interact with an insight on the DSS instance.

Important

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

delete()#: Delete the insight

get_settings()#

Get the insight’s definition

Returns:: a handle to inspect the insight definition
Return type:: dataikuapi.dss.insight.DSSInsightSettings

class dataikuapi.dss.insight.DSSInsightSettings(client, settings)#

Settings for an insight

Important

Do not instantiate directly, use dataikuapi.dss.insight.DSSInsight.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 insight
name : name (label) of the insight
owner : login of the owner of the insight
versionTag, creationTag, checklists, tags, customFields : common fields on DSS objects

Return type:

dict

save()#: Save the settings to the insight

property id#

Get the identifier of the insight

Note

The id is generated by DSS upon creation and random.

Return type:: string

property name#

Get the name of the insight

Note

The name is user-provided and not necessarily unique.

Return type:: str

property type#: Get the type of the insight (ex: “chart”) :rtype: str

property listed#

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

Return type:: bool

property owner#

Get the login of the owner of the insight

Return type:: str

class dataikuapi.dss.insight.DSSInsightListItem(client, data)#

An item in a list of insights.

Important

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

property id#

Get the identifier of the insight

Note

The id is generated by DSS upon creation and random.

Return type:: string

property name#

Get the name of the insight

Note

The name is user-provided and not necessarily unique.

Return type:: str

property type#: Get the type of the insight (ex: “chart”) :rtype: str

property listed#

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

Return type:: bool

property owner#

Get the login of the owner of the insight

Return type:: str

to_insight()#

Get a handle to interact with this insight

Returns:: a handle on the insight
Return type:: dataikuapi.dss.insight.DSSInsight