FastGPTFastGPT

获取应用图表数据

按绝对起止时间与固定时区偏移分组统计应用的用户增长、对话趋势与效果图表数据,支持按来源过滤与用户留存分析。

端点概览

  • HTTP 方法:POST
  • 请求路径:/api/proApi/core/app/logs/getChartData
  • 所属模块:应用管理 / 应用日志
  • 鉴权方式: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/proApi/core/app/logs/getChartData)

接口说明与注意事项

严格按起止绝对时间查询,不扩展查询窗口;用户、对话及应用数据统一按开始时间自带的固定偏移分组,无偏移时使用服务器时区,不接收独立时区参数。

请求参数

Request Body 请求体(application/json)

各分支公共字段

字段类型必填默认值约束与说明
dateStartstring是-开始时间(包含),ISO 字符串保留时区偏移及毫秒;统计使用该固定偏移,未带偏移时按服务器时区,Z 为 UTC
dateEndstring是-结束时间(包含),未带偏移时按服务器时区;保持客户端选择的边界,不额外扩展日期
sourcestring (enum)[]`否-对话来源筛选;省略表示全部来源,空数组表示无匹配
offsetnumber否1用户留存偏移量,单位随 userTimespan 变化;未传时默认 1;仅统计所选时间范围内的后续活跃
userTimespanstring (enum)是-用户数据时间跨度。可选值:day , week , month , quarter
chatTimespanstring (enum)是-对话数据时间跨度。可选值:day , week , month , quarter
appTimespanstring (enum)是-应用数据时间跨度。可选值:day , week , month , quarter

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

  • 显式指定应用

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

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

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

该分支无需额外字段。

请求示例

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

cURL 请求示例

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

最小合法 JSON 请求体示例

{
  "appId": "68ad85a7463006c963799a05",
  "dateStart": "2024-01-01T00:00:00.000Z",
  "dateEnd": "2024-12-31T23:59:59.999Z",
  "userTimespan": "day",
  "chatTimespan": "day",
  "appTimespan": "day"
}

响应结构与示例

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

HTTP 200

成功获取应用图表数据

Content-Type : application/json

字段类型必填默认值约束与说明
userDataobject[]是-用户统计数据
userData[].timestampnumber是-时间戳
userData[].summaryobject是-当前时间桶内的用户统计汇总
userData[].summary.userCountnumber是-用户总数
userData[].summary.newUserCountnumber是-新用户数
userData[].summary.retentionUserCountnumber是-留存用户数
userData[].summary.pointsnumber是-积分消耗
userData[].summary.inputTokensnumber是-输入 Token 消耗
userData[].summary.outputTokensnumber是-输出 Token 消耗
userData[].summary.sourceCountMapobject是-各来源用户数量
chatDataobject[]是-对话统计数据
chatData[].timestampnumber是-时间戳
chatData[].summaryobject是-当前时间桶内的对话统计汇总
chatData[].summary.chatItemCountnumber是-消息总数
chatData[].summary.chatCountnumber是-对话会话总数
chatData[].summary.errorCountnumber是-报错消息数量
chatData[].summary.pointsnumber是-积分消耗
chatData[].summary.inputTokensnumber是-输入 Token 消耗
chatData[].summary.outputTokensnumber是-输出 Token 消耗
appDataobject[]是-应用统计数据
appData[].timestampnumber是-时间戳
appData[].summaryobject是-当前时间桶内的应用效果统计汇总
appData[].summary.goodFeedBackCountnumber是-好评反馈数量
appData[].summary.badFeedBackCountnumber是-差评反馈数量
appData[].summary.chatCountnumber是-对话数量
appData[].summary.totalResponseTimenumber是-总响应时间(毫秒)
在 GitHub 上编辑

文件更新时间

本页导航

准备好开始了吗?

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