get_declarative_analytics_model

get_declarative_analytics_model(workspace_id: str, exclude: Optional[list[str]]) -> CatalogDeclarativeAnalytics

Retrieves declarative analytics model. The model is tied to the workspace and organization.

Parameters

name	type	description
workspace_id	str	Workspace identification string e.g. "demo"
exclude	Optional[list[str]]	Defines properties which should not be included in the payload. E.g.: ["ACTIVITY_INFO"]

Returns

type	description
CatalogDeclarativeAnalytics	Object Containing declarative Analytical Model

Example

# Get analytics model layout
declarative_analytics = sdk.catalog_workspace_content.get_declarative_analytics_model(
    workspace_id="123"
)

# CatalogDeclarativeAnalytics(
#   analytics=CatalogDeclarativeAnalyticsLayer(
#       analytical_dashboards=[
#           CatalogDeclarativeAnalyticalDashboard(
#               id='campaign',
#               title='Campaign',
#               content={
#                   'filterContextRef': {
#                       'identifier': {
#                           'id': 'campaign_name_filter',
#                           'type': 'filterContext'
#                       }
#                   },
#                   'layout': {
#                       'type': 'IDashboardLayout',
#                       'sections': [
#                           {
#                               'items': ```
#                               'type': 'IDashboardLayoutSection',
# ...

put_declarative_analytics_model