Dashboard Widgets (v1)

Overview

The Dashboard Widgets API allows workspace owners to customize their dashboard by adding, removing, and arranging widgets. Each workspace can have multiple widget instances with custom positions and sizes.

Widgets are organized into categories to make it easier to find and add them:

Sessions (الجلسات) - Session-related widgets
Clients (العملاء) - Client management widgets
Staff (الموظفين) - Staff and employee widgets
Financial (المالية) - Financial and revenue widgets
Orders (الطلبات) - Storefront and order widgets
Analytics (التحليلات) - Analytics and statistics widgets
Notifications (الإشعارات) - Notification widgets
Evaluations (التقييمات) - Evaluation and rating widgets
VCard (البطاقة الشخصية) - Virtual card widgets
Settings (الإعدادات) - Settings and workspace info widgets

The dashboard system includes 90 widgets organized into 10 categories:

Category	Count	Description
Sessions (الجلسات)	11	Session management, scheduling, and statistics
Clients (العملاء)	9	Client management, analytics, and retention
Staff (الموظفين)	7	Staff management, performance, and availability
Financial (المالية)	20	Revenue, expenses, income, recurring expenses, and financial analytics
Orders (الطلبات)	12	Storefront orders, products, and inventory
Analytics (التحليلات)	10	Analytics, KPIs, trends, and performance metrics
Notifications (الإشعارات)	5	Notification management and statistics
Evaluations (التقييمات)	5	Client evaluations and ratings
VCard (البطاقة الشخصية)	5	Virtual card analytics and statistics
Settings (الإعدادات)	6	Workspace settings, subscription, and usage tracking
Total	90	Complete dashboard widget ecosystem

Implemented (25 widgets): Fully functional widgets ready for use
Under Development (59 widgets): Widgets showing "قيد التطوير" status, available for customization but functionality is being developed

Available Widgets

Sessions Category (11 widgets)

sessions-status-chart - الجلسات حسب الحالة (Sessions distribution chart)
upcoming-sessions-table - الجلسات القادمة (Upcoming sessions table)
today-sessions - الجلسات اليوم (Today's sessions count)
weekly-sessions - الجلسات هذا الأسبوع (This week's sessions count)
monthly-sessions - الجلسات هذا الشهر (This month's sessions count)
delayed-sessions - الجلسات المتأخرة (Delayed sessions)
cancelled-sessions - الجلسات الملغاة (Cancelled sessions count)
sessions-by-staff - توزيع الجلسات حسب الموظف (Sessions distribution by staff)
sessions-by-service - توزيع الجلسات حسب الخدمة (Sessions distribution by service)
sessions-monthly-chart - إحصائيات الجلسات الشهرية (Monthly sessions statistics chart)
sessions-mini-calendar - تقويم الجلسات المصغر (Mini calendar showing scheduled sessions)

Clients Category (9 widgets)

total-clients - إجمالي العملاء (Total clients count)
new-clients-this-month - العملاء الجدد هذا الشهر (New clients this month)
active-clients - العملاء النشطون (Active clients count)
inactive-clients - العملاء غير النشطين (Inactive clients count)
top-spending-clients - العملاء الأكثر إنفاقاً (Top spending clients)
clients-with-balance - العملاء الذين لديهم رصيد مستحق (Clients with outstanding balance)
recent-clients - العملاء الجدد (Last 10 registered clients)
clients-by-tag - توزيع العملاء حسب الفئة (Clients distribution by tag/category)
client-retention-rate - معدل الاحتفاظ بالعملاء (Client retention rate)

Staff Category (7 widgets)

total-staff - إجمالي الموظفين (Total staff count)
active-staff - الموظفون النشطون (Active staff count)
available-staff-now - الموظفون المتاحون الآن (Currently available staff)
staff-performance - أداء الموظفين (Staff performance comparison by sessions)
staff-revenue - إيرادات الموظفين (Staff revenue comparison)
busiest-staff - الموظفون الأكثر انشغالاً (Busiest staff members)
staff-on-leave - الموظفون في إجازة (Staff currently on leave)

Financial Category (20 widgets)

revenue-today - إجمالي الإيرادات اليوم (Today's total revenue)
revenue-this-week - إجمالي الإيرادات هذا الأسبوع (This week's total revenue)
revenue-this-month - إجمالي الإيرادات هذا الشهر (This month's total revenue)
revenue-this-year - إجمالي الإيرادات هذا العام (This year's total revenue)
revenue-monthly-chart - الإيرادات حسب الشهر (Revenue chart by month)
pending-payments - المدفوعات المستحقة (Pending payments)
expenses-today - إجمالي المصاريف اليوم (Today's total expenses)
expenses-this-week - إجمالي المصاريف هذا الأسبوع (This week's total expenses)
expenses-this-month - إجمالي المصاريف هذا الشهر (This month's total expenses)
income-today - إجمالي المدخلات اليوم (Today's total income)
income-this-week - إجمالي المدخلات هذا الأسبوع (This week's total income)
income-this-month - إجمالي المدخلات هذا الشهر (This month's total income)
financial-overview-chart - رسم بياني شامل للمالية (Financial overview chart with expenses, income, and revenue with period filters)
monthly-growth-rate - معدل النمو الشهري (Monthly growth rate percentage)
recurring-expenses-stats - إحصائيات النفقات الدورية (Comprehensive statistics about recurring expenses: pending, posted, upcoming, skipped)
upcoming-recurring-expenses - النفقات الدورية القادمة (List of upcoming recurring expense occurrences)
recurring-expenses-this-month - إجمالي النفقات الدورية هذا الشهر (Total value of recurring expenses scheduled for this month)
pending-recurring-expenses - النفقات الدورية المعلقة (Count and value of pending recurring expenses that need attention)
active-recurring-expense-rules - قواعد النفقات الدورية النشطة (Count of active recurring expense rules)
recurring-expenses-by-frequency - توزيع النفقات الدورية حسب التكرار (Chart showing distribution of recurring expenses by frequency: daily, monthly, yearly)

Orders Category (12 widgets)

attention-orders - الطلبات التي تحتاج إلى متابعة (Orders needing attention)
most-ordered-products - المنتجات الأكثر طلباً (Most ordered products list)
most-visited-products - المنتجات الأكثر زيارة (Most visited products list)
orders-today - الطلبات اليوم (Today's orders count)
pending-orders - الطلبات المعلقة (Pending orders list)
completed-orders - الطلبات المكتملة (Completed orders count)
cancelled-orders - الطلبات الملغاة (Cancelled orders count)
storefront-revenue - إيرادات المتجر (Storefront total revenue)
monthly-orders - عدد الطلبات الشهري (Monthly orders count)
average-order-value - متوسط قيمة الطلب (Average order value)
low-stock-products - المنتجات قليلة المخزون (Low stock products list)
top-profitable-products - المنتجات الأكثر ربحية (Top profitable products)

Analytics Category (10 widgets)

visits-today-chart - الزيارات اليوم (Store and vCard visits today)
weekly-visits - إحصائيات الزيارات الأسبوعية (Weekly visits statistics chart)
monthly-visits - إحصائيات الزيارات الشهرية (Monthly visits statistics chart)
conversion-rate - معدل التحويل (Conversion rate: visitors to clients)
cancellation-rate - معدل الإلغاء (Session cancellation rate)
attendance-rate - معدل الحضور (Session attendance rate)
kpi-dashboard - مؤشرات الأداء الرئيسية (Key Performance Indicators dashboard)
performance-comparison - مقارنة الأداء (Performance comparison: this month vs last month)
growth-trends - اتجاهات النمو (Growth trends chart)
peak-hours-analysis - تحليل الذروة (Peak hours analysis for sessions)

Notifications Category (5 widgets)

unread-notifications - الإشعارات غير المقروءة (Unread notifications count)
recent-notifications - الإشعارات الأخيرة (Recent notifications list)
important-notifications - الإشعارات المهمة (Important notifications list)
notification-stats - إحصائيات الإشعارات (Notification statistics)
scheduled-notifications - الإشعارات المجدولة (Scheduled notifications count)

Evaluations Category (5 widgets)

pending-evaluations - التقييمات المعلقة (Pending evaluations list)
average-rating - متوسط التقييمات (Average client rating)
recent-evaluations - التقييمات الأخيرة (Recent evaluations list)
evaluation-distribution - توزيع التقييمات (Evaluation distribution chart)
evaluation-response-rate - معدل الاستجابة للتقييمات (Evaluation response rate)

VCard Category (5 widgets)

vcard-visits - زيارات البطاقة الشخصية (VCard visits count)
vcard-link-clicks - النقرات على الروابط (Link clicks in vCard)
vcard-shares - مشاركات البطاقة (VCard shares count)
vcard-monthly-stats - الإحصائيات الشهرية (Monthly vCard statistics)
vcard-top-sections - أكثر الأقسام زيارة (Most visited vCard sections)

Settings Category (6 widgets)

plan-pricing-card - خطة الاشتراك (Subscription plan information)
subscription-status - حالة الاشتراك (Subscription status display) - Implemented
storage-usage - استخدام التخزين (Storage usage display) - Implemented
sms-usage - استخدام SMS (SMS usage display) - Implemented
ai-usage - استخدام AI (AI features usage display) - Implemented
workspace-info - معلومات Workspace (Workspace basic information) - Implemented

Get Dashboard Widgets

Method & Path

GET /api/v1/workspace/:workspaceId/dashboard/widgets

Description

Retrieves all widgets configured for a workspace dashboard.

Authentication

Required: Workspace authentication via session cookie.

Headers

Content-Type: application/json
Cookie with workspace session

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID

Response 200 OK

{
  "widgets": [
    {
      "id": "507f1f77bcf86cd799439011",
      "workspaceId": "507f191e810c19729de860ea",
      "widgetId": "sessions-status-chart",
      "position": {
        "x": 0,
        "y": 0
      },
      "size": {
        "w": 4,
        "h": 4
      },
      "order": 0,
      "config": {
        "customTitle": "My Custom Chart",
        "backgroundColor": "#f0f0f0",
        "chartType": "line"
      },
      "groupId": "507f1f77bcf86cd799439012",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Config Object:

config can be null or an object containing widget customization options
customTitle (string, optional): Custom title displayed on the widget
backgroundColor (string, optional): CSS color value for widget background
chartType (string, optional): Chart type for chart widgets ("line", "bar", "pie", "area")

Group ID:

groupId (string | null, optional): The ID of the group this widget belongs to, or null if the widget is standalone

Common Errors

404 Not Found: Workspace not found or access denied 401 Unauthorized: Authentication required 403 Forbidden: Subscription expired or insufficient permissions

Get Available Widgets

Method & Path

GET /api/v1/workspace/dashboard/widgets/available

Description

Retrieves a list of all available widgets that can be added to the dashboard.

Authentication

None: This endpoint is public (no authentication required).

Response 200 OK

{
  "widgets": [
    {
      "id": "sessions-status-chart",
      "name": "الجلسات حسب الحالة",
      "description": "مخطط دائري يوضح توزيع الجلسات حسب الحالة",
      "category": "sessions",
      "defaultSize": {
        "w": 4,
        "h": 6
      }
    }
  ]
}

Method & Path

POST /api/v1/workspace/:workspaceId/dashboard/widgets

Description

Adds a new widget instance to the workspace dashboard.

Authentication

Required: Workspace authentication via session cookie.

Headers

Content-Type: application/json
Cookie with workspace session

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID

Request Body

{
  "widgetId": "sessions-status-chart",
  "position": {
    "x": 0,
    "y": 0
  },
  "size": {
    "w": 4,
    "h": 4
  },
  "config": null,
  "groupId": "507f1f77bcf86cd799439012"
}

Fields:

widgetId (string, required): The ID of the widget to add
position (object, optional): Initial position {x: number, y: number}. Defaults to {x: 0, y: 0}
size (object, optional): Initial size {w: number (1-12), h: number}. Defaults to widget's default size
config (object, optional): Widget-specific configuration. Can be null or an object with the following optional fields:
groupId (string | null, optional): The ID of the group to add this widget to, or null to make it standalone. Defaults to null
- customTitle (string, optional): Custom title for the widget. If not provided, the default widget name is used
- backgroundColor (string, optional): Background color for the widget in CSS color format (e.g., "#FF5733", "rgb(255, 87, 51)", "blue")
- chartType (string, optional): Chart type for chart widgets. Supported values: "line", "bar", "pie", "area". Only applicable to widgets that support chart type customization (e.g., sessions-by-service, sessions-by-staff, revenue-monthly-chart)

Response 201 Created

{
  "widget": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f191e810c19729de860ea",
    "widgetId": "sessions-status-chart",
    "position": {
      "x": 0,
      "y": 0
    },
    "size": {
      "w": 4,
      "h": 4
    },
    "order": 0,
    "config": {
      "customTitle": "My Sessions Chart",
      "backgroundColor": "#ffffff",
      "chartType": "bar"
    },
    "groupId": "507f1f77bcf86cd799439012",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Common Errors

400 Bad Request: Invalid widget ID or invalid position/size values 409 Conflict: Widget already exists in dashboard 404 Not Found: Workspace not found 401 Unauthorized: Authentication required 403 Forbidden: Subscription expired

Method & Path

PATCH /api/v1/workspace/:workspaceId/dashboard/widgets/:widgetInstanceId

Description

Updates a widget instance's position, size, configuration, or order.

Authentication

Required: Workspace authentication via session cookie.

Headers

Content-Type: application/json
Cookie with workspace session

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID
widgetInstanceId	string	Yes	The widget instance ID

Request Body

{
  "position": {
    "x": 4,
    "y": 0
  },
  "size": {
    "w": 6,
    "h": 4
  },
  "order": 1,
  "config": null,
  "groupId": "507f1f77bcf86cd799439012"
}

Fields (all optional):

position (object): New position {x: number, y: number}
size (object): New size {w: number (1-12), h: number}
order (number): New order for sorting
config (object): Widget-specific configuration. Can be null or an object with the following optional fields:
groupId (string | null): The ID of the group to move this widget to, or null to make it standalone
- customTitle (string, optional): Custom title for the widget. If not provided, the default widget name is used
- backgroundColor (string, optional): Background color for the widget in CSS color format (e.g., "#FF5733", "rgb(255, 87, 51)", "blue")
- chartType (string, optional): Chart type for chart widgets. Supported values: "line", "bar", "pie", "area". Only applicable to widgets that support chart type customization (e.g., sessions-by-service, sessions-by-staff, revenue-monthly-chart)

Response 200 OK

{
  "widget": {
    "id": "507f1f77bcf86cd799439011",
    "workspaceId": "507f191e810c19729de860ea",
    "widgetId": "sessions-status-chart",
    "position": {
      "x": 4,
      "y": 0
    },
    "size": {
      "w": 6,
      "h": 4
    },
    "order": 1,
    "config": null,
    "groupId": "507f1f77bcf86cd799439012",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T12:00:00.000Z"
  }
}

Common Errors

400 Bad Request: Invalid position/size values 404 Not Found: Widget instance not found 401 Unauthorized: Authentication required 403 Forbidden: Subscription expired

Method & Path

DELETE /api/v1/workspace/:workspaceId/dashboard/widgets/:widgetInstanceId

Description

Removes a widget instance from the workspace dashboard.

Authentication

Required: Workspace authentication via session cookie.

Headers

Cookie with workspace session

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID
widgetInstanceId	string	Yes	The widget instance ID

Response 204 No Content

No response body.

Common Errors

404 Not Found: Widget instance not found 401 Unauthorized: Authentication required 403 Forbidden: Subscription expired

Reorder Dashboard Widgets

Method & Path

PUT /api/v1/workspace/:workspaceId/dashboard/widgets/reorder

Description

Updates the position, size, and order of multiple widgets at once. Useful for batch updates after drag-and-drop operations.

Authentication

Required: Workspace authentication via session cookie.

Headers

Content-Type: application/json
Cookie with workspace session

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	The workspace ID

Request Body

{
  "widgets": [
    {
      "id": "507f1f77bcf86cd799439011",
      "position": {
        "x": 0,
        "y": 0
      },
      "size": {
        "w": 4,
        "h": 4
      },
      "order": 0
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "position": {
        "x": 4,
        "y": 0
      },
      "size": {
        "w": 8,
        "h": 4
      },
      "order": 1
    }
  ]
}

Fields:

widgets (array, required): Array of widget updates, each containing:
- id (string, required): Widget instance ID
- position (object, required): Position {x: number, y: number}
- size (object, required): Size {w: number (1-12), h: number}
- order (number, required): Order for sorting

Response 200 OK

{
  "widgets": [
    {
      "id": "507f1f77bcf86cd799439011",
      "workspaceId": "507f191e810c19729de860ea",
      "widgetId": "sessions-status-chart",
      "position": {
        "x": 0,
        "y": 0
      },
      "size": {
        "w": 4,
        "h": 4
      },
      "order": 0,
      "config": null,
      "groupId": "507f1f77bcf86cd799439012",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T12:00:00.000Z"
    }
  ]
}

Common Errors

400 Bad Request: Invalid widget IDs or position/size values 404 Not Found: Some widget IDs do not belong to this workspace 401 Unauthorized: Authentication required 403 Forbidden: Subscription expired

Grid Layout System

The dashboard uses a 12-column grid system:

Width (w): 1-12 (1 = 1/12 of width, 12 = full width)
Height (h): Measured in grid units (each unit = 50px by default)
Position (x, y): Grid coordinates (0-based)

Common Sizes:

Small: w: 3, h: 4 (quarter width)
Medium: w: 6, h: 4 (half width)
Large: w: 9, h: 4 (three-quarters width)
Full: w: 12, h: 4 (full width)

Widgets can be organized into groups for better dashboard organization. See Dashboard Widget Groups API for group management endpoints.

Standalone Widgets: Widgets with groupId: null are displayed independently on the dashboard
Grouped Widgets: Widgets with a groupId are displayed within their group container
Moving Widgets: Use the move-to-group endpoint or update the widget's groupId field to move widgets between groups

Session Statistics Endpoints

These endpoints provide statistics data for session widgets.

Get Cancelled Sessions Count

Method & Path

GET /api/v1/workspace/:workspaceId/sessions/stats/cancelled

Description

Returns the count of cancelled sessions for the workspace.

Authentication

Required: Workspace authentication via session cookie. Requires sessions.view permission.

Query Parameters

Parameter	Type	Required	Description
dateFrom	string (ISO datetime)	No	Start date for filtering (inclusive)
dateTo	string (ISO datetime)	No	End date for filtering (inclusive)

Response 200 OK

{
  "count": 15
}

Get Sessions by Staff

Method & Path

GET /api/v1/workspace/:workspaceId/sessions/stats/by-staff

Description

Returns the distribution of sessions by staff member. Only includes sessions that have a staffId assigned (sessions with a responsible staff member).

Authentication

Required: Workspace authentication via session cookie. Requires sessions.view permission.

Query Parameters

Parameter	Type	Required	Description
dateFrom	string (ISO datetime)	No	Start date for filtering (inclusive)
dateTo	string (ISO datetime)	No	End date for filtering (inclusive)

Response 200 OK

{
  "staff": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "أحمد محمد",
      "count": 25
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "name": "فاطمة علي",
      "count": 18
    }
  ]
}

Get Sessions by Service

Method & Path

GET /api/v1/workspace/:workspaceId/sessions/stats/by-service

Description

Returns the distribution of sessions by service.

Authentication

Required: Workspace authentication via session cookie. Requires sessions.view permission.

Query Parameters

Parameter	Type	Required	Description
dateFrom	string (ISO datetime)	No	Start date for filtering (inclusive)
dateTo	string (ISO datetime)	No	End date for filtering (inclusive)

Response 200 OK

{
  "services": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "استشارة طبية",
      "count": 45
    },
    {
      "id": "507f1f77bcf86cd799439012",
      "name": "جلسة علاجية",
      "count": 32
    }
  ]
}

Get Monthly Sessions Statistics

Method & Path

GET /api/v1/workspace/:workspaceId/sessions/stats/monthly

Description

Returns monthly session statistics for the specified number of months.

Authentication

Required: Workspace authentication via session cookie. Requires sessions.view permission.

Query Parameters

Parameter	Type	Required	Description
months	number	No	Number of months to retrieve (default: 12)

Response 200 OK

{
  "monthly": [
    {
      "month": 1,
      "year": 2024,
      "count": 120,
      "breakdown": {
        "scheduled": 30,
        "completed": 80,
        "cancelled": 10
      }
    },
    {
      "month": 2,
      "year": 2024,
      "count": 135,
      "breakdown": {
        "scheduled": 35,
        "completed": 90,
        "cancelled": 10
      }
    }
  ]
}

Sessions Category (11 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`sessions-status-chart`	الجلسات حسب الحالة	Sessions distribution chart	8 × 6
`upcoming-sessions-table`	الجلسات القادمة	Upcoming sessions table	12 × 8
`today-sessions`	الجلسات اليوم	Today's sessions count	6 × 4
`weekly-sessions`	الجلسات هذا الأسبوع	This week's sessions count	6 × 4
`monthly-sessions`	الجلسات هذا الشهر	This month's sessions count	6 × 4
`delayed-sessions`	الجلسات المتأخرة	Delayed sessions	6 × 5
`cancelled-sessions`	الجلسات الملغاة	Cancelled sessions count	6 × 4
`sessions-by-staff`	توزيع الجلسات حسب الموظف	Sessions distribution by staff	8 × 6
`sessions-by-service`	توزيع الجلسات حسب الخدمة	Sessions distribution by service	8 × 6
`sessions-monthly-chart`	إحصائيات الجلسات الشهرية	Monthly sessions statistics chart	12 × 6
`sessions-mini-calendar`	تقويم الجلسات المصغر	Mini calendar showing scheduled sessions	6 × 6

Clients Category (9 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`total-clients`	إجمالي العملاء	Total clients count	4 × 3
`new-clients-this-month`	العملاء الجدد هذا الشهر	New clients this month	4 × 3
`active-clients`	العملاء النشطون	Active clients count	4 × 3
`inactive-clients`	العملاء غير النشطين	Inactive clients count	4 × 3
`top-spending-clients`	العملاء الأكثر إنفاقاً	Top spending clients	6 × 5
`clients-with-balance`	العملاء الذين لديهم رصيد مستحق	Clients with outstanding balance	6 × 5
`recent-clients`	العملاء الجدد	Last 10 registered clients	6 × 5
`clients-by-tag`	توزيع العملاء حسب الفئة	Clients distribution by tag/category	8 × 6
`client-retention-rate`	معدل الاحتفاظ بالعملاء	Client retention rate	6 × 4

Staff Category (7 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`total-staff`	إجمالي الموظفين	Total staff count	4 × 3
`active-staff`	الموظفون النشطون	Active staff count	4 × 3
`available-staff-now`	الموظفون المتاحون الآن	Currently available staff	6 × 4
`staff-performance`	أداء الموظفين	Staff performance comparison by sessions	8 × 6
`staff-revenue`	إيرادات الموظفين	Staff revenue comparison	8 × 6
`busiest-staff`	الموظفون الأكثر انشغالاً	Busiest staff members	6 × 5
`staff-on-leave`	الموظفون في إجازة	Staff currently on leave	6 × 4

Financial Category (20 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`revenue-today`	إجمالي الإيرادات اليوم	Today's total revenue	4 × 3
`revenue-this-week`	إجمالي الإيرادات هذا الأسبوع	This week's total revenue	4 × 3
`revenue-this-month`	إجمالي الإيرادات هذا الشهر	This month's total revenue	4 × 3
`revenue-this-year`	إجمالي الإيرادات هذا العام	This year's total revenue	4 × 3
`revenue-monthly-chart`	الإيرادات حسب الشهر	Revenue chart by month	12 × 6
`pending-payments`	المدفوعات المستحقة	Pending payments	6 × 5
`expenses-today`	إجمالي المصاريف اليوم	Today's total expenses	4 × 3
`expenses-this-week`	إجمالي المصاريف هذا الأسبوع	This week's total expenses	4 × 3
`expenses-this-month`	إجمالي المصاريف هذا الشهر	This month's total expenses	4 × 3
`income-today`	إجمالي المدخلات اليوم	Today's total income	4 × 3
`income-this-week`	إجمالي المدخلات هذا الأسبوع	This week's total income	4 × 3
`income-this-month`	إجمالي المدخلات هذا الشهر	This month's total income	4 × 3
`financial-overview-chart`	رسم بياني شامل للمالية	Financial overview chart with expenses, income, and revenue with period filters (daily, weekly, monthly, yearly)	12 × 8
`monthly-growth-rate`	معدل النمو الشهري	Monthly growth rate percentage	6 × 4
`recurring-expenses-stats`	إحصائيات النفقات الدورية	Comprehensive statistics about recurring expenses (pending, posted, upcoming, skipped)	8 × 6
`upcoming-recurring-expenses`	النفقات الدورية القادمة	List of upcoming recurring expense occurrences	6 × 6
`recurring-expenses-this-month`	إجمالي النفقات الدورية هذا الشهر	Total value of recurring expenses scheduled for this month	4 × 3
`pending-recurring-expenses`	النفقات الدورية المعلقة	Count and value of pending recurring expenses that need attention	4 × 3
`active-recurring-expense-rules`	قواعد النفقات الدورية النشطة	Count of active recurring expense rules	4 × 3
`recurring-expenses-by-frequency`	توزيع النفقات الدورية حسب التكرار	Chart showing distribution of recurring expenses by frequency (daily, monthly, yearly)	8 × 6

Orders Category (12 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`attention-orders`	الطلبات التي تحتاج إلى متابعة	Orders needing attention	12 × 6
`most-ordered-products`	المنتجات الأكثر طلباً	Most ordered products list	6 × 5
`most-visited-products`	المنتجات الأكثر زيارة	Most visited products list	6 × 5
`orders-today`	الطلبات اليوم	Today's orders count	4 × 3
`pending-orders`	الطلبات المعلقة	Pending orders list	6 × 5
`completed-orders`	الطلبات المكتملة	Completed orders count	6 × 5
`cancelled-orders`	الطلبات الملغاة	Cancelled orders count	6 × 4
`storefront-revenue`	إيرادات المتجر	Storefront total revenue	4 × 3
`monthly-orders`	عدد الطلبات الشهري	Monthly orders count	6 × 4
`average-order-value`	متوسط قيمة الطلب	Average order value	4 × 3
`low-stock-products`	المنتجات قليلة المخزون	Low stock products list	6 × 5
`top-profitable-products`	المنتجات الأكثر ربحية	Top profitable products	6 × 5

Analytics Category (10 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`visits-today-chart`	الزيارات اليوم	Store and vCard visits today	12 × 4
`weekly-visits`	إحصائيات الزيارات الأسبوعية	Weekly visits statistics chart	6 × 4
`monthly-visits`	إحصائيات الزيارات الشهرية	Monthly visits statistics chart	6 × 4
`conversion-rate`	معدل التحويل	Conversion rate: visitors to clients	4 × 3
`cancellation-rate`	معدل الإلغاء	Session cancellation rate	4 × 3
`attendance-rate`	معدل الحضور	Session attendance rate	4 × 3
`kpi-dashboard`	مؤشرات الأداء الرئيسية	Key Performance Indicators dashboard	12 × 6
`performance-comparison`	مقارنة الأداء	Performance comparison: this month vs last month	12 × 6
`growth-trends`	اتجاهات النمو	Growth trends chart	12 × 6
`peak-hours-analysis`	تحليل الذروة	Peak hours analysis for sessions	8 × 6

Notifications Category (5 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`unread-notifications`	الإشعارات غير المقروءة	Unread notifications count	4 × 3
`recent-notifications`	الإشعارات الأخيرة	Recent notifications list	6 × 5
`important-notifications`	الإشعارات المهمة	Important notifications list	6 × 5
`notification-stats`	إحصائيات الإشعارات	Notification statistics	6 × 4
`scheduled-notifications`	الإشعارات المجدولة	Scheduled notifications count	6 × 4

Evaluations Category (5 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`pending-evaluations`	التقييمات المعلقة	Pending evaluations list	6 × 5
`average-rating`	متوسط التقييمات	Average client rating	4 × 3
`recent-evaluations`	التقييمات الأخيرة	Recent evaluations list	6 × 5
`evaluation-distribution`	توزيع التقييمات	Evaluation distribution chart	8 × 6
`evaluation-response-rate`	معدل الاستجابة للتقييمات	Evaluation response rate	6 × 4

VCard Category (5 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`vcard-visits`	زيارات البطاقة الشخصية	VCard visits count	6 × 4
`vcard-link-clicks`	النقرات على الروابط	Link clicks in vCard	6 × 4
`vcard-shares`	مشاركات البطاقة	VCard shares count	6 × 4
`vcard-monthly-stats`	الإحصائيات الشهرية	Monthly vCard statistics	8 × 6
`vcard-top-sections`	أكثر الأقسام زيارة	Most visited vCard sections	6 × 5

Settings Category (6 widgets)

Widget ID	Name (Arabic)	Description	Default Size
`plan-pricing-card`	خطة الاشتراك	Subscription plan information	4 × 4
`subscription-status`	حالة الاشتراك	Subscription status display with end date and days remaining	4 × 3
`storage-usage`	استخدام التخزين	Storage usage display with quota and file statistics	6 × 4
`sms-usage`	استخدام SMS	SMS usage display with message statistics, costs, and balance	6 × 4
`ai-usage`	استخدام AI	AI features usage display with usage statistics, costs, and balance	6 × 4
`workspace-info`	معلومات Workspace	Workspace basic information including contact details, settings, and metadata	6 × 5

Overview​

Widget Categories​

Widget Summary​

Widget Status​

Available Widgets​

Sessions Category (11 widgets)​

Clients Category (9 widgets)​

Staff Category (7 widgets)​

Financial Category (20 widgets)​

Orders Category (12 widgets)​

Analytics Category (10 widgets)​

Notifications Category (5 widgets)​

Evaluations Category (5 widgets)​

VCard Category (5 widgets)​

Settings Category (6 widgets)​

Get Dashboard Widgets​

Method & Path​

Description​

Authentication​

Headers​

Path Parameters​

Response 200 OK​

Common Errors​

Get Available Widgets​

Method & Path​

Description​

Authentication​

Response 200 OK​

Add Dashboard Widget​

Method & Path​

Description​

Authentication​

Headers​

Path Parameters​

Request Body​

Response 201 Created​

Common Errors​

Update Dashboard Widget​

Method & Path​

Description​

Authentication​

Headers​

Path Parameters​

Request Body​

Response 200 OK​

Common Errors​

Delete Dashboard Widget​

Method & Path​

Description​

Authentication​

Headers​

Path Parameters​

Response 204 No Content​

Common Errors​

Reorder Dashboard Widgets​

Method & Path​

Description​

Authentication​

Headers​

Path Parameters​

Request Body​

Response 200 OK​

Common Errors​

Grid Layout System​

Common Sizes:​

Widget Groups​

Session Statistics Endpoints​

Get Cancelled Sessions Count​

Method & Path​

Description​

Authentication​

Query Parameters​

Response 200 OK​

Get Sessions by Staff​

Method & Path​

Description​

Authentication​

Query Parameters​

Response 200 OK​

Get Sessions by Service​

Overview

Widget Categories

Widget Summary

Widget Status

Available Widgets

Sessions Category (11 widgets)

Clients Category (9 widgets)

Staff Category (7 widgets)

Financial Category (20 widgets)

Orders Category (12 widgets)

Analytics Category (10 widgets)

Notifications Category (5 widgets)

Evaluations Category (5 widgets)

VCard Category (5 widgets)

Settings Category (6 widgets)

Get Dashboard Widgets

Method & Path

Description

Authentication

Headers

Path Parameters

Response 200 OK

Common Errors

Get Available Widgets

Method & Path

Description

Authentication

Response 200 OK

Add Dashboard Widget

Method & Path

Description

Authentication

Headers

Path Parameters

Request Body

Response 201 Created

Common Errors

Update Dashboard Widget

Method & Path

Description

Authentication

Headers

Path Parameters

Request Body

Response 200 OK

Common Errors

Delete Dashboard Widget

Method & Path

Description

Authentication

Headers

Path Parameters

Response 204 No Content

Common Errors

Reorder Dashboard Widgets

Method & Path

Description

Authentication

Headers

Path Parameters

Request Body

Response 200 OK

Common Errors

Grid Layout System

Common Sizes:

Widget Groups

Session Statistics Endpoints

Get Cancelled Sessions Count

Method & Path

Description

Authentication

Query Parameters

Response 200 OK

Get Sessions by Staff

Method & Path

Description

Authentication

Query Parameters

Response 200 OK

Get Sessions by Service