GetDepartmentUsages - 查询部门使用数据
通过 OpenAPI 查询通义灵码部门使用数据。
适用版本 | 企业标准版、企业专属版 |
服务接入点与授权信息
获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
请求语法
GET https://<domain>/oapi/v1/lingma/organizations/<organizationId>/departmentUsage?departmentId=<departmentId>&startTime=<startTime>&endTime=<endtime>请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 所属企业 ID。 | 99d1****71d4 |
departmentId | string | query | 是 | 部门 ID。 | 8446****ce9f |
startTime | string | query | 是 | 开始时间，格式为 YYYY-MM-DD. | 2024-06-30 |
endTime | string | query | 是 | 结束时间，格式为 YYYY-MM-DD。 | 2024-07-04 |
page | integer | query | 否 | 当前页，默认1。 | |
perPage | integer | query | 否 | 每页数据条数，默认100。 |
请求示例
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/lingma/organizations/99d1****71d4/departmentUsage?departmentId=8446****ce9f&startTime=2024-06-30&endTime=2024-07-04' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token:pt-0fh3****0fbG_35af****0484'返回参数
参数 | 类型 | 描述 | 示例值 |
date | long | 日期。 | 1731427200000 |
departmentId | string | 云效部门 ID。 | 99d1****71d4 |
activeDeveloper | integer | 活跃开发者数量。 | 0 |
activeDeveloperChat | integer | 问答活跃开发者数量。 | 0 |
activeDeveloperCompletion | integer | 代码生成活跃开发者数量。 | 0 |
totalChatTurns | integer | 该用户当天问答次数。 | 0 |
totalChatTurnsAccepted | integer | 总的问答采纳次数。 | 0 |
totalCountAcceptedCompletion | integer | 总代码补全的采纳次数。 | 5 |
totalCountSuggestedCompletion | integer | 总代码补全的推荐次数。 | 12 |
totalLinesAccepted | integer | 该用户当天采纳代码行数。 | 0 |
totalLinesAcceptedCompletion | integer | 该用户当天用行间生成采纳代码行数。 | 0 |
totalLinesChanged | integer | 该用户当天变更行数。 | 0 |
totalLinesSuggestedCompletion | integer | 该用户当天用行间生成推荐代码行数。 | 0 |
breakdown | object | ||
chatting | object | 问答明细数据。 | |
- | array | ||
- | object | ||
chatTurns | integer | 问答次数。 | |
chatTurnsAccepted | integer | 问答采纳次数 | 0 |
activeDeveloper | integer | 活跃用户数。 | 0 |
chatType | string | 问答类型。 | CODE_GENERATE_COMMENT（代码注释），GENERATE_TESTCASE（单元测试），EXPLAIN_CODE（代码解释），OPTIMIZE_CODE（代码优化），FREE_INPUT（自由问答），非大写字母串（自定义指令） |
ide | string | ide编辑器类型jetbrains/vscode等 | vscode |
coding | object | 代码变更明细数据，包括行间补全、问答生成采纳明细数据。 | |
- | array | ||
- | object | ||
language | string | 语言。 | |
linesChanged | integer | 代码变更行数。 | 0 |
linesAccepted | integer | 代码采纳行数。 | 0 |
activeDeveloper | integer | 活跃用户数。 | 0 |
completion | object | 行间补全生成采纳明细数据。 | |
- | array | ||
- | object | ||
language | string | 语言。 | |
linesSuggested | integer | 代码变更行数。 | 0 |
linesAccepted | integer | 代码采纳行数。 | 0 |
ide | string | ide编辑器类型jetbrains/vscode等 | vscode |
activeDeveloper | integer | 活跃用户数。 | 0 |
countAccepted | integer | 采纳次数。 | 5 |
countSuggested | integer | 推荐次数。 | 7 |
返回示例
[
{
"date": 1731427200000,
"departmentId": "99d1****71d4",
"activeDeveloper": 0,
"activeDeveloperChat": 0,
"activeDeveloperCompletion": 0,
"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",
"activeDeveloper": 0,
"ide": "vscode"
}
],
"coding": [
{
"language": "typescript",
"linesAccepted": 0,
"linesChanged": 0,
"activeDeveloper": 0
}
],
"completion": [
{
"countAccepted": 0,
"countSuggested": 0,
"ide": "vscode",
"activeDeveloper": 0,
"language": "typescript",
"linesAccepted": 0,
"linesSuggested": 0
}
]
}
}
]响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页。 | 1 |
x-per-page | 每页数据条数。 | 100 |
x-prev-page | 上一页。 | 1 |
x-total | 总数据量。 | 2 |
x-total-pages | 总分页数。 | 1 |
响应头示例
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 //总条数
x-total-pages: 1 //总页数错误码
访问错误码中心查看 API 相关错误码。