GetDepartmentUsages - 查询部门使用数据
通过 OpenAPI 查询通义灵码部门使用数据。
适用版本 | 企业标准版、企业专属版 |
服务接入点与授权信息
获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。
获取organizationId，请前往组织管理后台的基本信息页面获取组织 ID，具体请参见 organizationId 获取方式。
请求语法
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 | 在指定日期，至少触发过一次通义灵码的代码补全功能或智能问答功能的用户量，即为活跃开发者数量。 | 1 |
activeDeveloperChat | integer | 在指定日期，至少用过一次通义灵码的智能问答功能的用户量，即为问答活跃开发者数量。 | 1 |
activeDeveloperCompletion | integer | 在指定日期，至少使用过一次通义灵码的代码补全功能的用户量，即为代码生成活跃开发者数量。 | 0 |
totalChatTurns | integer | 用户在指定日期使用智能问答的次数。 | 0 |
totalChatTurnsAccepted | integer | 用户在指定日期采纳智能问答推荐回答的总次数，单个回答被采纳一次即计为一次采纳。 | 70 |
totalCountAcceptedCompletion | integer | 用户通过行间代码补全功能，使用 Tab 键采纳推荐代码的次数。 | 5 |
totalCountSuggestedCompletion | integer | 通义灵码通过行间代码补全功能，推荐代码展示给用户的次数。 | 12 |
totalLinesAccepted | integer | 用户主动点击 Tab 键接纳代码行数以及将问答区的代码等复制到编辑区的行数。 | 0 |
totalLinesAcceptedCompletion | integer | 用户通过行间代码补全功能，使用 Tab 键采纳推荐代码的行数。 | 0 |
totalLinesChanged | integer | 用户进行代码变更的行数，包括新增行和修改行并去重。 | 0 |
totalLinesSuggestedCompletion | integer | 通义灵码通过行间代码补全功能，推荐代码展示给用户的行数。 | 0 |
breakdown | object | 通义灵码通过智能问答、行间代码补全和代码变更的明细数据，包含以下三个数组详细数据：
| |
chatting | array | 智能问答的明细数据，包含以下参数：
| |
chatTurns | integer | 问答次数。 | |
chatTurns Accepted | integer | 用户在指定日期采纳智能问答推荐回答的总次数，单个回答被采纳一次即计为一次采纳。 | 0 |
active Developer | integer | 在指定日期，至少触发过一次智能问答功能的用户量，即为活跃用户数。 | 0 |
chatType | string | 问答类型，取值如下：
| CODE_GENERATE_COMMENT |
ide | string | ide编辑器类型jetbrains/vscode等 | vscode |
coding | array | 代码相关明细数据，涵盖行间代码补全和问答生成的代码，包含以下参数：
| |
language | string | 语言。 | |
lines Changed | integer | 用户进行代码变更的行数，包括新增、修改行并进行去重。 | 10 |
lines Accepted | integer | 用户主动点击 Tab 键接纳代码行数以及将问答区的代码等复制到编辑区的行数。 | 5 |
active Developer | integer | 在指定日期，至少使用过一次代码补全和问答生成功能的用户量，即为活跃用户数。 | 1 |
completion | array | 行间代码补全的明细数据，包含以下参数：
| |
language | string | 语言。 | |
lines Suggested | integer | 用户进行代码变更的行数，包括新增、修改行。 | 70 |
lines Accepted | integer | 用户主动点击 Tab 键接纳的代码行数。 | 50 |
ide | string | ide编辑器类型jetbrains/vscode等 | vscode |
active Developer | integer | 在指定日期，至少使用过一次代码补全功能的用户量，即为活跃用户数。 | 1 |
count Accepted | integer | 用户主动点击 Tab 键接纳的代码次数。 | 5 |
count Suggested | 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 相关错误码。
相关文档
API使用中若遇到相关问题，请参见OpenAPI相关问题。