介面模組使用指南
資料統計模組
功能說明
介面字首統一為 http(s)://<your-domain>
生產環境應使用 HTTPS 以保證認證令牌。 HTTP 僅建議用於開發環境。
用量資料的聚合統計系統 。管理員可檢視全站統計,使用者可檢視個人統計。資料按模型和日期分組,用於生成圖表和報表,監控系統使用趨勢。
🔐 使用者鑑權
我的用量按日期統計
- 介面名稱:我的用量按日期統計
- HTTP 方法:GET
- 路徑:
/api/data/self - 鑑權要求:使用者
- 功能簡介:獲取當前使用者的用量資料按日期統計,支援時間範圍查詢
💡 請求示例:
const response = await fetch('/api/data/self?start_timestamp=1640908800&end_timestamp=1640995200', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_user_token',
'New-Api-User': 'your_user_id'
}
});
const data = await response.json();✅ 成功響應示例:
{
"success": true,
"message": "",
"data": [
{
"model_name": "gpt-3.5-turbo",
"count": 25,
"quota": 12500,
"token_used": 2000,
"created_at": 1640995200,
"user_id": 1,
"username": "testuser"
},
{
"model_name": "gpt-4",
"count": 10,
"quota": 30000,
"token_used": 1500,
"created_at": 1640995200,
"user_id": 1,
"username": "testuser"
}
]
}❗ 失敗響應示例:
{
"success": false,
"message": "獲取個人統計資料失敗"
}🧾 欄位說明:
start_timestamp(數字): 開始時間戳,可選end_timestamp(數字): 結束時間戳,可選data(陣列): 個人統計資料列表model_name(字串): 模型名稱count(數字): 請求次數quota(數字): 配額消耗token_used(數字): Token 使用量created_at(數字): 統計日期時間戳user_id(數字): 使用者 IDusername(字串): 使用者名稱
🔐 管理員鑑權
全站用量按日期統計
- 介面名稱:全站用量按日期統計
- HTTP 方法:GET
- 路徑:
/api/data/ - 鑑權要求:管理員
- 功能簡介:獲取系統全站用量資料按日期統計,支援按使用者名稱過濾和時間範圍查詢
💡 請求示例:
const response = await fetch('/api/data/?start_timestamp=1640908800&end_timestamp=1640995200&username=testuser', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_admin_token',
'New-Api-User': 'your_user_id'
}
});
const data = await response.json();✅ 成功響應示例:
{
"success": true,
"message": "",
"data": [
{
"model_name": "gpt-3.5-turbo",
"count": 150,
"quota": 75000,
"token_used": 12500,
"created_at": 1640995200
},
{
"model_name": "gpt-4",
"count": 50,
"quota": 150000,
"token_used": 8000,
"created_at": 1640995200
}
]
}❗ 失敗響應示例:
{
"success": false,
"message": "獲取統計資料失敗"
}🧾 欄位說明:
start_timestamp(數字): 開始時間戳,可選end_timestamp(數字): 結束時間戳,可選username(字串): 使用者名稱過濾,可選data(陣列): 統計資料列表,按模型和日期分組聚合model_name(字串): 模型名稱count(數字): 請求次數總和quota(數字): 配額消耗總和token_used(數字): Token 使用量總和created_at(數字): 統計日期時間戳