通义灵码 - 查询开发者成员使用数据_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 查询通义灵码开发者成员使用数据。

适用版本	企业标准版、企业专属版

服务接入点与授权信息

获取服务接入点，替换 API 请求语法中的 <domain> ：服务接入点（domain）。
获取个人访问令牌，具体操作，请参见获取个人访问令牌。

请求语法

GET  https://<domain>/oapi/v1/lingma/organizations/<organizationId>/developerUsage?userId=<userId>&startTime=<starTime>&endTime=<endTime>

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是	所属企业 ID。	99d1****71d4
userId	string	query	否	用户 ID与部门 ID 根据需求选一个参数填写。说明两个参数同时传值，会以用户id过滤；如果同时不传值，会查询企业下所有用户数据。	3693****e234
departmentId	string	query	否
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/developerUsage?startTime=2024-06-30&endTime=2024-07-04' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token:pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
date	integer	日期。
userId	string	用户 ID。	3693****e234
statusActive	boolean	该用户是否活跃。
statusActiveChat	boolean	该用户是否活跃在问答。
statusActiveCompletion	boolean	该用户是否活跃在代码生成。
statusActiveLastedTime	string	该用户当天最后的活跃时刻。
totalChatTurns	integer	该用户当天问答次数。
totalLinesChanged	integer	该用户当天变更行数。
totalLinesAccepted	integer	该用户当天采纳代码行数。
chatting		问答明细数据。
chatType	string	问答类型。
chatTurns	integer	问答次数。
coding		代码变更明细数据。
language	string	语言。
linesChanged	integer	代码变更行数。
linesAccepted	integer	代码采纳行数。

返回示例

[
  {
    "date": 0,
    "userId": "3693****e234",
    "statusActive": true,
    "statusActiveChat": true,
    "statusActiveCompletion": true,
    "statusActiveLastedTime": "string",
    "totalChatTurns": 0,
    "totalLinesChanged": 0,
    "totalLinesAccepted": 0,
    "breakdown": {
      "chatting": [
        {
          "chatType": "string",
          "chatTurns": 0
        }
      ],
      "coding": [
        {
          "language": "string",
          "linesChanged": 0,
          "linesAccepted": 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 相关错误码。