GetDeveloperUsages - 查詢開發(fā)者成員使用數(shù)據(jù)
通過 OpenAPI 查詢通義靈碼開發(fā)者成員使用數(shù)據(jù)。
適用版本 | 企業(yè)標(biāo)準版、企業(yè)專屬版 |
服務(wù)接入點與授權(quán)信息
獲取服務(wù)接入點，替換 API 請求語法中的 <domain> ：服務(wù)接入點（domain）。
獲取個人訪問令牌，具體操作，請參見獲取個人訪問令牌。
請求語法
GET https://<domain>/oapi/v1/lingma/organizations/<organizationId>/developerUsage?userId=<userId>&startTime=<starTime>&endTime=<endTime>請求頭
參數(shù) | 類型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 個人訪問令牌。 | pt-0fh3****0fbG_35af****0484 |
請求參數(shù)
參數(shù) | 類型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 所屬企業(yè) ID。 | 99d1****71d4 |
userId | string | query | 否 | 用戶 ID與部門 ID 根據(jù)需求選一個參數(shù)填寫。 說明 兩個參數(shù)同時傳值，會以用戶id過濾 ；如果同時不傳值，會查詢企業(yè)下所有用戶數(shù)據(jù)。 | 3693****e234 |
departmentId | string | query | 否 | ||
startTime | string | query | 是 | 開始時間，格式為 YYYY-MM-DD. | 2024-06-30 |
endTime | string | query | 是 | 結(jié)束時間，格式為 YYYY-MM-DD。 | 2024-07-04 |
page | integer | query | 否 | 當(dāng)前頁，默認1。 | 1 |
perPage | integer | query | 否 | 每頁數(shù)據(jù)條數(shù)，默認100。 | 100 |
請求示例
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/developerUsage?startTime=2024-06-30&endTime=2024-07-04' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token:pt-0fh3****0fbG_35af****0484'返回參數(shù)
參數(shù) | 類型 | 描述 | 示例值 |
date | long | 日期。 | 1731427200000 |
userId | string | 用戶 ID。 | 3693****e234 |
statusActive | boolean | 該用戶是否活躍。 | true |
statusActiveChat | boolean | 該用戶是否活躍在問答。 | true |
statusActiveCompletion | boolean | 該用戶是否活躍在代碼生成。 | true |
statusActiveLastedTime | long | 該用戶當(dāng)天最后的活躍時刻。 | 1731427200000 |
totalChatTurns | integer | 該用戶當(dāng)天問答次數(shù)。 | 0 |
totalChatTurnsAccepted | integer | 總的問答采納次數(shù)。 | 0 |
totalCountAcceptedCompletion | integer | 總代碼補全的采納次數(shù)。 | 5 |
totalCountSuggestedCompletion | integer | 總代碼補全的推薦次數(shù)。 | 12 |
totalLinesAccepted | integer | 該用戶當(dāng)天采納代碼行數(shù)。 | 0 |
totalLinesAcceptedCompletion | integer | 該用戶當(dāng)天用行間生成采納代碼行數(shù)。 | 0 |
totalLinesChanged | integer | 該用戶當(dāng)天變更行數(shù)。 | 0 |
totalLinesSuggestedCompletion | integer | 該用戶當(dāng)天用行間生成推薦代碼行數(shù)。 | 0 |
breakdown | object | ||
chatting | object | 問答明細數(shù)據(jù)。 | |
- | array | ||
- | object | ||
chatTurns | integer | 問答次數(shù)。 | |
chatTurnsAccepted | integer | 問答采納次數(shù)。 | 0 |
chatType | string | 問答類型。 | CODE_GENERATE_COMMENT（代碼注釋），GENERATE_TESTCASE（單元測試），EXPLAIN_CODE（代碼解釋），OPTIMIZE_CODE（代碼優(yōu)化），F(xiàn)REE_INPUT（自由問答），非大寫字母串（自定義指令） |
ide | string | ide編輯器類型jetbrains/vscode等。 | vscode |
coding | object | 代碼變更明細數(shù)據(jù)，包括行間補全、問答生成采納明細數(shù)據(jù)。 | |
- | array | ||
- | object | ||
language | string | 語言。 | |
linesChanged | integer | 代碼變更行數(shù)。 | 0 |
linesAccepted | integer | 代碼采納行數(shù)。 | 0 |
completion | object | 行間補全生成采納明細數(shù)據(jù)。 | |
- | array | ||
- | object | ||
language | string | 語言。 | |
linesSuggested | integer | 代碼變更行數(shù)。 | 0 |
linesAccepted | integer | 代碼采納行數(shù)。 | 0 |
ide | string | ide編輯器類型jetbrains/vscode等。 | vscode |
countAccepted | integer | 采納次數(shù)。 | 5 |
countSuggested | integer | 推薦次數(shù)。 | 7 |
返回示例
[
{
"userId": "3693****e234",
"date": 1731427200000,
"statusActive": true,
"statusActiveChat": true,
"statusActiveCompletion": true,
"statusActiveLastedTime": 1731427200000,
"totalChatTurns": 0,
"totalChatTurnsAccepted": 0,
"totalCountAcceptedCompletion": 0,
"totalCountSuggestedCompletion": 0,
"totalLinesAccepted": 0,
"totalLinesAcceptedCompletion": 0,
"totalLinesChanged": 0,
"totalLinesSuggestedCompletion": 0,
"breakdown": {
"chatting": [
{
"chatTurns": 0,
"chatTurnsAccepted": 0,
"chatType": "FREE_INPUT",
"ide": "vscode"
}
],
"coding": [
{
"language": "typescript",
"linesAccepted": 0,
"linesChanged": 0
}
],
"completion": [
{
"countAccepted": 0,
"countSuggested": 0,
"ide": "vscode",
"language": "typescript",
"linesAccepted": 0,
"linesSuggested": 0
}
]
}
}
] 響應(yīng)頭
參數(shù) | 描述 | 示例值 |
x-next-page | 下一頁。 | 1 |
x-per-page | 每頁數(shù)據(jù)條數(shù)。 | 100 |
x-prev-page | 上一頁。 | 1 |
x-total | 總數(shù)據(jù)量。 | 2 |
x-total-pages | 總分頁數(shù)。 | 1 |
響應(yīng)頭示例
connection: keep-alive
content-length: 481
content-type: application/json; charset=UTF-8
date: Thu,04 Jul 2024 13:44:21 GMT
x-next-page: 1
x-per-page: 100 //每頁大小
x-prev-page: 1
x-total: 2 //總條數(shù)
x-total-pages: 1 //總頁數(shù)錯誤碼
訪問錯誤碼中心查看 API 相關(guān)錯誤碼。