get_dashboard_data
Retrieve quarterly dashboard data to track Common Control Framework compliance status across categories and frameworks. Monitor control assignments, view completion metrics, and analyze compliance percentages for specific periods.
Instructions
Function accepts compliance period as 'period'. Period denotes for which quarter of year dashboard data is needed. Format: Q1 2024.
Dashboard contains summary data of Common Control Framework (CCF). For any related to contorl category, framework, assignment status use this function. This contains details of control status such as 'Completed', 'In Progress', 'Overdue', 'Pending'. The summarization levels are 'overall control status', 'control category wise', 'control framework wise', 'overall control status' can be fetched from 'controlStatus' 'control category wise' can be fetched from 'controlSummary' 'control framework wise' can be fetched from 'frameworks'
Args: - period (str) - Period denotes for which quarter of year dashboard data is needed. Format: Q1 2024.
Returns: - totalControls (int): Total number of controls in the dashboard. - controlStatus (List[ComplianceStatusSummaryVO]): Summary of control statuses. - status (str): Compliance status of the control. - count (int): Number of controls with the given status. - controlAssignmentStatus (List[ControlAssignmentStatusVO]): Assignment status categorized by control. - categoryName (str): Name of the control category. - controlStatus (List[ComplianceStatusSummaryVO]): Status summary within the category. - status (str): Compliance status. - count (int): Number of controls with this status. - compliancePCT (float): Overall compliance percentage across all controls. - controlSummary (List[ControlSummaryVO]): Detailed summary of each control. - category (str): Category name of the control. - status (str): Compliance status of the control. - dueDate (str): Due date for the control, if applicable. - compliancePCT (float): Compliance percentage for the control. - leafControls (int): Number of leaf-level controls in the category. - complianceStatusSummary (List[ComplianceStatusSummaryVO]): Summary of control statuses. - status (str): Compliance status. - count (int): Number of controls with the given status. - error (Optional[str]): An error message if any issues occurred during retrieval.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| period | No | Q1 2024 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| totalControls | No | ||
| controlStatus | No | ||
| controlAssignmentStatus | No | ||
| compliancePCT | No | ||
| controlSummary | No | ||
| complianceStatusSummary | No | ||
| frameworks | No | ||
| error | No |