FastGPTFastGPT

获取日志用户列表

分页获取应用对话日志中的团队成员与外链使用者列表,支持按来源筛选、用户名关键词检索及按对话数量排序。

端点概览

  • HTTP 方法:POST
  • 请求路径:/api/core/app/logs/getUsers
  • 所属模块:应用管理 / 应用日志
  • 鉴权方式:Authorization: Bearer <apiKey>—支持 应用 API Key(无需 appId)与 个人密钥(需传 appId)(详见 API 入门:完成首次请求)
  • 在线调试:在云服务 Scalar 调试台打开(自部署实例请将域名替换为 <instance>/apidoc/systemopenapi#tag/%E5%BA%94%E7%94%A8%E6%97%A5%E5%BF%97/POST/core/app/logs/getUsers)

接口说明与注意事项

获取应用日志中的用户列表,包括外链用户和团队成员,按对话数量排序,支持搜索和分页

请求参数

Request Body 请求体(application/json)

互斥参数分支(anyOf 选填其一)

  • 显式指定应用

个人密钥或登录态必须传 appId;应用 Key 始终以 Key 绑定的应用为准。

字段类型必填默认值约束与说明
appIdstring是-应用 ID。最小长度:1
  • 应用 API Key(无需 appId)

Authorization 使用绑定应用的 APP API Key 时无需传 appId 或 sourceType,服务端从 Key 绑定取得应用,sourceType 固定为 app。个人密钥和登录态不能使用此省略方式;显式传入 appId 时仍以 Key 绑定为准。

该分支无需额外字段。

各分支公共字段

字段类型必填默认值约束与说明
dateStartstring是-开始时间
dateEndstring是-结束时间
searchKeystring否-搜索用户名
sourcesstring[]否-来源筛选

互斥参数分支(anyOf 选填其一)

  • 按偏移量获取

通过 offset 指定起始位置,从 0 开始;同时传入页码时优先使用 offset。

字段类型必填默认值约束与说明
offsetinteger是-互斥参数组:分页参数。偏移量,从 0 开始。最小值:0;最大值:9007199254740991
pageSizeinteger否20互斥参数组:分页参数。每页条数,默认 20,最大 500,超出自动按 500 处理。最大值:500
  • 按页码获取

通过页码获取,默认第 1 页;pageSize 控制每页条数。

字段类型必填默认值约束与说明
pageNuminteger否1互斥参数组:分页参数。页码,从 1 开始;传入 offset 时忽略。最大值:9007199254740991
pageSizeinteger否20互斥参数组:分页参数。每页条数,默认 20,最大 500,超出自动按 500 处理。最大值:500

请求示例

调用前请将 YOUR_API_KEY 与示例 ID 替换为真实值;私有化部署实例请将基础域名替换为 <instance>/api。

cURL 请求示例

curl --fail-with-body -X POST "https://cloud.fastgpt.cn/api/core/app/logs/getUsers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "appId": "68ad85a7463006c963799a05",
  "offset": 0,
  "dateStart": "2024-01-01T00:00:00.000Z",
  "dateEnd": "2024-12-31T23:59:59.999Z"
}'

最小合法 JSON 请求体示例

{
  "appId": "68ad85a7463006c963799a05",
  "offset": 0,
  "dateStart": "2024-01-01T00:00:00.000Z",
  "dateEnd": "2024-12-31T23:59:59.999Z"
}

响应结构与示例

除兼容 OpenAI 协议的对话补全或二进制下载接口外,成功响应统一包裹在 { "code": 200, "statusText": "", "message": "", "data": ... } 标准结构中;下方 200 字段表对应 data 载荷结构(若契约未声明具体载荷结构,请以上方状态描述及实际响应为准)。

HTTP 200

成功获取日志用户列表

Content-Type : application/json

字段类型必填默认值约束与说明
totalnumber是0-
listobject[]是[]-
list[].outLinkUidstring | null是-使用者 ID,外链访客或 API customUid;非空时优先于 tmbId
list[].tmbIdstring | null是-本次实际鉴权成员 ID,代理调用时为被代理成员
list[].namestring是-用户名称
list[].avatarstring否-头像
list[].countnumber是-对话数量
在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

让你的企业知识真正被 AI 用起来