获取部门使用数据
通过 OpenAPI 获取通义灵码部门使用数据。
适用版本 | 企业标准版、企业专属版 |
服务接入点与授权信息
获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID，具体请参见 organizationId 获取方式。
产品 | 资源 | 所需权限 |
通义灵码 | 部门使用统计 | 只读 |
请求语法
GET https://{domain}/oapi/v1/lingma/organizations/{organizationId}/departmentUsage请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 所属企业 ID。 | |
departmentId | string | query | 是 | 部门 ID。 | |
startTime | string | query | 是 | 开始时间，格式为 YYYY-MM-DD。 | |
endTime | string | query | 是 | 结束时间，格式为 YYYY-MM-DD。 | |
page | integer | query | 否 | 当前页，默认1。 | |
perPage | integer | query | 否 | 每页数据条数，默认100。 |
请求示例
curl -X 'GET' \
'https://{domain}/oapi/v1/lingma/organizations/{organizationId}/departmentUsage?departmentId={departmentId}&startTime={startTime}&endTime={endTime}&page={page}&perPage={perPage}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回参数
参数 | 类型 | 描述 | 示例值 |
- | array | ||
- | object | ||
activeDeveloper | integer | 活跃开发者数量。 | |
activeDeveloperChat | integer | 问答活跃开发者数量。 | |
activeDeveloperCompletion | integer | 代码生成活跃开发者数量。 | |
breakdown | object | 明细数据。 | |
chatting | array | 问答明细数据。 | |
- | object | ||
activeDeveloper | integer | 活跃用户数。 | |
chatTurns | integer | 问答次数。 | |
chatTurnsAccepted | integer | 问答采纳次数。 | |
chatType | string | 问答类型，CODE_GENERATE_COMMENT（代码注释），GENERATE_TESTCASE（单元测试），EXPLAIN_CODE（代码解释），OPTIMIZE_CODE（代码优化），FREE_INPUT（自由问答），非大写字母串（自定义指令）。 | |
ide | string | ide 编辑器类型 jetbrains/vscode 等。 | |
coding | array | 代码变更明细数据，包括行间补全、问答生成汇总采纳明细数据。 | |
- | object | ||
acceptAssistantNewlineCount | integer | 该部门当天按问答和语言采纳的明细代码行数。 | |
activeDeveloper | integer | 活跃用户数。 | |
language | string | 语言。 | |
linesAccepted | integer | 代码采纳行数。 | |
linesChanged | integer | 代码变更行数。 | |
completion | array | 行间补全生成采纳明细数据。 | |
- | object | ||
activeDeveloper | integer | 活跃用户数。 | |
countAccepted | integer | 采纳次数。 | |
countSuggested | integer | 推荐次数。 | |
ide | string | ide 编辑器类型 jetbrains/vscode 等。 | |
language | string | 语言。 | |
linesAccepted | integer | 代码采纳行数。 | |
linesChanged | integer | 代码变更行数。 | |
date | integer | 日期。 | |
departmentId | string | 云效部门 ID。 | |
totalChatTurns | integer | 该部门当天问答次数。 | |
totalChatTurnsAccepted | integer | 该部门当天按问答方式采纳的次数。 | |
totalCountAcceptedCompletion | integer | 该部门当天代码补全采纳的次数。 | |
totalCountSuggestedCompletion | integer | 该部门当天代码补全推荐的次数。 | |
totalLinesAccepted | integer | 该部门当天采纳代码行数，包括ask，edit（原ai程序员），agent问答生成和行间补全的总采纳行数。 | |
totalLinesAcceptedChat | integer | 该部门当天按问答方式采纳的代码总行数。 | |
totalLinesAcceptedCompletion | integer | 该部门当天代码补全采纳的代码总行数。 | |
totalLinesChanged | integer | 该部门当天变更行数，包括ask，edit（原ai程序员），agent问答生成和行间补全的总变更行数。 | |
totalLinesSuggestedCompletion | integer | 该部门当天代码补全推荐的代码总行数。 |
返回示例
[
{
"activeDeveloper": 0,
"activeDeveloperChat": 0,
"activeDeveloperCompletion": 0,
"breakdown": {
"chatting": [
{
"activeDeveloper": 0,
"chatTurns": 0,
"chatTurnsAccepted": 0,
"chatType": "",
"ide": ""
}
],
"coding": [
{
"acceptAssistantNewlineCount": 0,
"activeDeveloper": 0,
"language": "",
"linesAccepted": 0,
"linesChanged": 0
}
],
"completion": [
{
"activeDeveloper": 0,
"countAccepted": 0,
"countSuggested": 0,
"ide": "",
"language": "",
"linesAccepted": 0,
"linesChanged": 0
}
]
},
"date": 0,
"departmentId": "",
"totalChatTurns": 0,
"totalChatTurnsAccepted": 0,
"totalCountAcceptedCompletion": 0,
"totalCountSuggestedCompletion": 0,
"totalLinesAccepted": 0,
"totalLinesAcceptedChat": 0,
"totalLinesAcceptedCompletion": 0,
"totalLinesChanged": 0
"totalLinesSuggestedCompletion": 0
}
]响应头
参数 | 描述 | 示例值 |
x-next-page | 下一页。 | 1 |
x-per-page | 每页数据条数。 | 100 |
x-prev-page | 上一页。 | 1 |
x-total | 总数据量。 | 2 |
x-total-pages | 总分页数。 | 1 |
错误码
访问错误码中心查看 API 相关错误码。
相关文档
API使用中若遇到相关问题，请参见OpenAPI相关问题。