Skip to main content

Get Dashboard Overview (v1)

Get platform dashboard statistics and attention orders.

Method & Path​

GET /v1/admin/dashboard/overview

Description​

Retrieves platform-wide dashboard statistics and orders that require attention. This endpoint provides an overview of key platform metrics.

Authentication​

Required: Admin authentication with dashboard.view permission.

Include the admin JWT token in the Authorization header:

Authorization: Bearer <admin_token>

Headers​

Authorization: Bearer <admin_token>
Content-Type: application/json

Query Parameters​

None.

Request Body​

None.

Response 200 OK​

{
  "metrics": {
    "totalBusinesses": 0,
    "pendingApprovals": 0,
    "activeSubscriptions": 0,
    "monthlyRecurringRevenue": 0
  },
  "attentionOrders": [
    {
      "id": "507f1f77bcf86cd799439011",
      "workspaceId": "507f1f77bcf86cd799439012",
      "status": "pending",
      "total": 150.00,
      "createdAt": "2024-01-15T10:00:00Z"
    }
  ]
}

Common Errors​

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions (missing dashboard.view permission)
  • 500 Internal Server Error: Server error (may occur if fetching attention orders fails, but request still succeeds with empty array)