Dashboards

dashboards

Dashboards module for the Kaleidoscope system.

This module provides classes and services for working with dashboards in Kaleidoscope. Dashboards summarize data across a workspace in some way, allowing for data comparison, status review, and more.

Classes:

Name	Description
Dashboard	Represents a single dashboard with its categories and configurations.
DashboardsService	Service class for managing and querying dashboards.

Example

# get all dashboards
dashboards = client.dashboards.get_dashboards()

DashboardType module-attribute

DashboardType: TypeAlias = Literal['decision'] | Literal['data'] | Literal['chart'] | Literal['field'] | Literal['summary']

Type alias representing the valid types of dashboards in the system.

This type defines the allowed string values for the dashboard_type field in Dashboard models.

DashboardCategory

Bases: _KaleidoscopeBaseModel

Represents the definition of a DashboardCategory in the Kaleidoscope system.

A DashboardCategory defines a summary and aggregation for entities and sets in that dashboard.

Attributes:

Name	Type	Description
id	str	UUID of the Dashboard Category.
dashboard_id	str	The dashboard this category is a part of.
category_name	str	The name of the category.
operation_definition_ids	list[str]	The operation activity definitions reflected in this category.
label_ids	list[list[str]]	The labels reflected in this category.
field_ids	list[str]	The fields reflected in this category.

Dashboard

Bases: _KaleidoscopeBaseModel

Represents a dashboard in the Kaleidoscope system.

A Dashboard represents an aggregation and summarization of the state of a workspace with respect to both entity data and activity.

Attributes:

Name	Type	Description
id	str	UUID of the dashboard.
dashboard_name	str	The name of the dashboard.
dashboard_description	str	The description of the dashboard.
dashboard_type	DashboardType	The type of the dashboard, representing how it aggregates data.
record_ids	list[str]	List of record IDs associated with the dashboard.
record_set_ids	list[str]	List of record set IDs associated with the dashboard.

Methods:

Name	Description
add_category	Create a new dashboard category on this dashboard.
remove_category	Remove a category from the dashboard.
get_categories	Retrieve all categories associated with this dashboard.
add_record	Add a record to the dashboard.
remove_record	Remove a record from the dashboard.
add_set	Add a set to the dashboard.
remove_set	Remove a set from the dashboard.

add_category

add_category(category_name: str, operation_definition_ids: list[str], label_ids: list[list[str]], field_ids: list[str]) -> DashboardCategory

Create a new dashboard category on this dashboard.

Parameters:

Name	Type	Description	Default
category_name	str	The name of the new category.	required
operation_definition_ids	list[str]	A list of operation definition IDs to include in the category.	required
label_ids	list[list[str]]	A list of label IDs to include in the category.	required
field_ids	list[str]	A list of field IDs to include in the category.	required

Returns:

Name	Type	Description
DashboardCategory	DashboardCategory	The newly created category object.

Raises:

Type	Description
KalbioAPIError	If the API request fails.

Source code in kalbio/dashboards.py

def add_category(
    self,
    category_name: str,
    operation_definition_ids: List[str],
    label_ids: List[List[str]],
    field_ids: List[str],
) -> DashboardCategory:
    """Create a new dashboard category on this dashboard.

    Args:
        category_name (str): The name of the new category.
        operation_definition_ids (List[str]): A list of operation definition IDs to include in the category.
        label_ids (List[List[str]]): A list of label IDs to include in the category.
        field_ids (List[str]): A list of field IDs to include in the category.

    Returns:
        DashboardCategory: The newly created category object.

    Raises:
        KalbioAPIError: If the API request fails.
    """
    data = {
        "category_name": category_name,
        "operation_definition_ids": operation_definition_ids,
        "label_ids": label_ids,
        "field_ids": field_ids,
    }
    resp = self._client._post(
        f"/dashboards/{self.id}/categories",
        data,
    )
    return resp

remove_category

remove_category(category_id: str)

Remove a category from the dashboard.

Parameters:

Name	Type	Description	Default
category_id	str	The unique identifier of the category to be removed.	required

Source code in kalbio/dashboards.py

def remove_category(self, category_id: str):
    """Remove a category from the dashboard.

    Args:
        category_id (str): The unique identifier of the category to be removed.
    """
    self._client._delete(
        f"/dashboards/{self.id}/categories/{category_id}",
    )

get_categories

get_categories() -> list[DashboardCategory]

Retrieve all categories associated with this dashboard.

Returns:

Type	Description
list[DashboardCategory]	List[DashboardCategory]: A list of DashboardCategory objects associated with this dashboard.

Source code in kalbio/dashboards.py

def get_categories(self) -> List[DashboardCategory]:
    """Retrieve all categories associated with this dashboard.

    Returns:
        List[DashboardCategory]: A list of DashboardCategory objects associated with this dashboard.
    """
    resp = self._client._get(
        f"/dashboards/{self.id}/categories",
    )
    if resp is None:
        return []
    return resp

add_record

add_record(record_id: str)

Add a record to the dashboard.

Parameters:

Name	Type	Description	Default
record_id	str	The unique identifier of the record to be added.	required

Source code in kalbio/dashboards.py

def add_record(self, record_id: str):
    """Add a record to the dashboard.

    Args:
        record_id (str): The unique identifier of the record to be added.
    """
    data = {"record_id": record_id}
    resp = self._client._post(f"/dashboards/{self.id}/records", data)
    if resp:
        self.record_ids = resp.record_ids

remove_record

remove_record(record_id: str)

Remove a record from the dashboard.

Parameters:

Name	Type	Description	Default
record_id	str	The unique identifier of the record to be removed.	required

Source code in kalbio/dashboards.py

def remove_record(self, record_id: str):
    """Remove a record from the dashboard.

    Args:
        record_id (str): The unique identifier of the record to be removed.
    """
    self._client._delete(
        f"/dashboards/{self.id}/records/{record_id}",
    )

add_set

add_set(set_id)

Add a set to the dashboard.

Parameters:

Name	Type	Description	Default
set_id	str	The unique identifier of the set to be added.	required

Source code in kalbio/dashboards.py

def add_set(self, set_id):
    """Add a set to the dashboard.

    Args:
        set_id (str): The unique identifier of the set to be added.
    """
    data = {"set_id": set_id}
    resp = self._client._post(f"/dashboards/{self.id}/sets", data)
    if resp:
        self.record_set_ids = resp.record_set_id

remove_set

remove_set(set_id: str)

Remove a set from the dashboard.

Parameters:

Name	Type	Description	Default
set_id	str	The unique identifier of the set to be removed.	required

Source code in kalbio/dashboards.py

def remove_set(self, set_id: str):
    """Remove a set from the dashboard.

    Args:
        set_id (str): The unique identifier of the set to be removed.
    """
    resp = self._client._delete(
        f"/dashboards/{self.id}/sets/{set_id}",
    )
    if resp:
        self.record_set_ids = resp.record_set_id

DashboardsService

DashboardsService(client: KaleidoscopeClient)

Service class for managing and retrieving dashboards from the Kaleidoscope API.

This service provides methods to fetch dashboards. It handles the conversion of raw API responses into validated Dashboard objects.

Attributes:

Name	Type	Description
client	KaleidoscopeClient	The Kaleidoscope client instance used for API communication.

Example

client = KaleidoscopeClient(...)
dashboards = client.dashboards.get_dashboards()

Methods:

Name	Description
get_dashboards	Retrieve a list of dashboards from the client.

Source code in kalbio/dashboards.py

def __init__(self, client: KaleidoscopeClient):
    self._client = client

get_dashboards cached

get_dashboards() -> list[Dashboard]

Retrieve a list of dashboards from the client.

Returns:

Type	Description
list[Dashboard]	List[Dashboard]: A list of Dashboard objects created from the response.

Source code in kalbio/dashboards.py

@lru_cache
def get_dashboards(self) -> List[Dashboard]:
    """Retrieve a list of dashboards from the client.

    Returns:
        List[Dashboard]: A list of Dashboard objects created from the response.
    """
    resp = self._client._get("/dashboards")
    return self._create_dashboard_list(resp)