Dashboard API

Endpoints for retrieving chart data and managing layout configurations.

Analytics & Charts

List All Dashboard Data

Retrieve aggregated data for all dashboard widgets.

HTTP Method & URL: GET /api/admin/Dashboard/allDashboard

Request

Headers

Name	Value	Required	Description
X-API-KEY	string	Yes	Your unique API key.

cURL

curl -X GET "https://stg.itechops.com/api/admin/Dashboard/allDashboard" \
     -H "X-API-KEY: your_api_key_here"

Responses

200 OK

Description: Success. Returns a comprehensive dashboard dataset.

401 Unauthorized

Description: Authentication failed.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid or missing API key."
}

500 Server Error

Description: Internal server error.

{
  "Success": false,
  "Result": null,
  "Message": "An unexpected error occurred."
}

---

Generic Chart Data

Retrieve data for various chart types based on filters.

HTTP Method & URL: POST /api/admin/Dashboard/GetChartData

Request

Payload

Body: JSON object with time range and component filters.

{
  "Range": "30days",
  "ComponentIds": ["3fa85f64-5717-4562-b3fc-2c963f66afa0"]
}

Responses

200 OK

Description: Success. Returns requested chart data.

{
  "Success": true,
  "Result": [
    { "Label": "Oct 1", "Value": 99.9 },
    { "Label": "Oct 2", "Value": 98.5 }
  ],
  "Message": "Success"
}

400 Bad Request

Description: Invalid filter parameters.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid date range specified."
}

401 Unauthorized

Description: Authentication failed.

{
  "Success": false,
  "Result": null,
  "Message": "Invalid or missing API key."
}

500 Server Error

Description: Internal server error.

{
  "Success": false,
  "Result": null,
  "Message": "An unexpected error occurred."
}

---

Other Analytics Endpoints

• GET /api/admin/Dashboard/averageResponseTime: Get global average response time.
• POST /api/admin/Dashboard/GetComponentUptimeData: Get uptime statistics per component.
• POST /api/admin/Dashboard/GetPieChartData: Get data for pie chart visualizations.
• POST /api/admin/Dashboard/GetAllChartData: Bulk retrieve all chart data.
• POST /api/admin/Dashboard/GetCustomChartData: Filtered chart data requests.

---

Dynamic Layouts & Widgets

Manage the visual arrangement of the dashboard.

• POST /api/admin/Dashboard/AddDragDropDashBoardLayout: Save a drag-and-drop layout.
• GET /api/admin/Dashboard/GetDragDropDashBoardLayout: Retrieve the current layout.
• POST /api/admin/Dashboard/AddDynamicChart: Add a new dynamic chart widget.
• GET /api/admin/Dashboard/GetDynamicChart: List configured dynamic charts.
• DELETE /api/admin/Dashboard/DeleteDynamicChartLayout: Remove a dynamic chart.
• DELETE /api/admin/Dashboard/DeleteDragLayout: Reset the drag-and-drop layout.

---

Dynamic Dashboards

Create and manage custom dashboard views.

• POST /api/admin/Dashboard/AddDynamicDashboard: Create a custom dashboard view.
• GET /api/admin/Dashboard/GetDynamicDashboard: Get a specific dynamic dashboard.
• GET /api/admin/Dashboard/GetDynamicDashboardAll: List all dynamic dashboards.
• DELETE /api/admin/Dashboard/DeleteDynamicDashboard: Remove a dashboard.