超腾开源平台仪表盘模块

仪表盘模块提供系统统计数据的查询功能，用于展示平台各项指标的统计概览。

API 接口

获取仪表盘统计数据

获取系统的各项统计数据，包括用户、博客、订单等关键指标。

接口地址: GET /api/dashboard/stats

请求参数: 无

需要认证: 是

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "操作成功",
  "data": {
    "apps": 5,
    "users": 120,
    "blogs": 350,
    "blogs_draft": 25,
    "blog_comments": 1200,
    "blog_comments_draft": 35,
    "feedbacks": 85,
    "feedbacks_pending": 12,
    "feedbacks_processing": 50,
    "wikis": 200,
    "wiki_comments": 500,
    "wiki_comments_pending": 15,
    "email_subscriptions": 300,
    "email_subscriptions_verified": 250,
    "links": 45,
    "links_pending": 8,
    "orders": 800,
    "orders_paid": 650,
    "items": 150,
    "items_out_of_stock": 10,
    "item_reviews": 1200,
    "item_reviews_pending": 25,
    "softwares": 30,
    "software_draft": 5,
    "agents": 20,
    "llm_models": 15,
    "llm_providers": 8,
    "llm_prompts": 100,
    "remote_hosts": 5,
    "remote_hosts_online": 4,
    "spider_logs": 5000,
    "spider_logs_today": 200,
    "notifications": 500,
    "notifications_unread": 15,
    "today_pv": 2500,
    "today_uv": 800,
    "today_ip": 750,
    "today_direct_visits": 500,
    "today_referral_visits": 300,
    "today_search_visits": 1200,
    "today_social_visits": 100,
    "today_new_visitors": 200,
    "today_returning_visitors": 600
  }
}

响应字段说明:

强制刷新仪表盘统计数据

强制刷新仪表盘统计数据，清除缓存后重新获取最新的统计信息。

接口地址: POST /api/dashboard/stats/refresh

请求参数: 无

需要认证: 是

响应示例:

{
  "success": true,
  "code": 200,
  "msg": "统计数据已刷新",
  "data": {
    "apps": 5,
    "users": 121,
    "blogs": 351,
    ...
  }
}

使用示例

Python 示例

import requests

# 获取仪表盘统计数据
response = requests.get(
    'http://localhost:8000/api/dashboard/stats',
    headers={'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}
)

if response.status_code == 200:
    data = response.json()
    if data['success']:
        stats = data['data']
        print(f"用户数量: {stats['users']}")
        print(f"博客数量: {stats['blogs']}")
        print(f"今日访问量: {stats['today_pv']}")

JavaScript 示例

// 获取仪表盘统计数据
async function getDashboardStats() {
  const response = await fetch("http://localhost:8000/api/dashboard/stats", {
    headers: {
      Authorization: "Bearer YOUR_ACCESS_TOKEN",
    },
  });

  const data = await response.json();
  if (data.success) {
    const stats = data.data;
    console.log("用户数量:", stats.users);
    console.log("博客数量:", stats.blogs);
    console.log("今日访问量:", stats.today_pv);
  }
}

cURL 示例

# 获取仪表盘统计数据
curl -X GET "http://localhost:8000/api/dashboard/stats" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

# 强制刷新仪表盘统计数据
curl -X POST "http://localhost:8000/api/dashboard/stats/refresh" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

注意事项

1. 缓存机制: 仪表盘统计数据默认会缓存，以提高性能。如需获取最新数据，请调用强制刷新接口。
2. 性能考虑: 强制刷新接口会清除缓存并重新计算所有统计数据，可能会消耗较多服务器资源，建议不要频繁调用。
3. 数据更新频率: 仪表盘统计数据通常定时更新，具体频率取决于系统配置。
4. 权限要求: 访问仪表盘数据需要登录认证，普通用户和管理员都可以访问。

相关文档

• 系统模块 API
• 统计模块 API
• 数据模型参考