七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
在线系统数据接口

查询企业满意度报表总览

查询 appKey 所属企业的满意度报表总览。请求体必须是 JSON 对象;startTime 或 endTime 任一缺失时,接口默认查询昨天结束的近 30 天。startTime 和 endTime 同时传入时,会校验 endTime 不大于当前时间、startTime 不大于 endTime,并按企业当前限制校验查询跨度。shuntGroup、kefuShunt 为逗号分隔字符串;platforms 为 JSON 字符串。成功响应的 message 字段为满意度总览对象。

请求参数

名称类型必填描述示例值
timeany是请求时间戳(秒);与服务器时间误差超过 10 分钟会鉴权失败
checksumany是请求签名校验和
checksumAlgorithminteger否签名算法:0 - 默认(SHA1),1 - SHA256;不传默认为 0
appKeystring是应用 AppKey

请求体

名称类型必填描述示例值
startTimeint64否查询开始时间,毫秒时间戳。startTime 或 endTime 任一缺失时,接口默认查询昨天结束的近 30 天。1735660800000
endTimeint64否查询结束时间,毫秒时间戳。与 startTime 同时传入时必须不大于当前时间,且不早于 startTime。1738252799999
sessionOriginint32否会话来源过滤:不传或 0 不过滤;1-访客直接访问;其他非 0 值按客服主动发起过滤。0
shuntGroupstring否分流组 ID 列表,逗号分隔字符串。空或不传表示不过滤;重复 ID 会被去重。101,102,103
kefuShuntstring否客服分流 ID 列表,逗号分隔字符串。空或不传表示不过滤;重复 ID 会被去重。2001,2002
platformsstring否平台过滤条件的 JSON 字符串,元素格式为 {"type":"平台类型","value":"平台 ID 或逗号分隔的平台 ID"}。type 支持 web、wx_work、wxkf、wx、open、iOS、harmony、android、wb、wx_ma、wx_sdk、douyin、facebook、line、feishu、dingding、wx_cs、twitter、whatsapp、instagram、discord、wxworkweb、youzan、weimob、xiaohongshu、meituan、wxstore、bilibili、feishu_im、baidu_self_build_site。[{"type":"web","value":"1,2"},{"type":"wx","value":""}]
isValidint32否有效会话过滤:不传不过滤;1-仅有效会话;其他非 null 值按无效会话过滤。1

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject满意度总览数据
└satisfactionRatioobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└evaCountint64参评数128
└noEvaluationCountint64未评数32
└inviteEvaCountint64邀请评价参评数96
└entryEvaluationCountint64常驻入口参评数20
└verySatisfiedCountint64非常满意会话数80
└satisfiedCountint64满意会话数30
└normalSatisfiedCountint64一般会话数10
└veryNotSatisfiedCountint64非常不满意会话数3
└notSatisfiedCountint64不满意会话数5
└inviteCountint64邀请评价数160
└staffInviteCountint64人工邀请评价数70
└autoInviteCountint64系统邀请评价数90
└userResolvedCountint64评价已解决数100
└userUnResolvedCountint64评价未解决数12
└evaRatioobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└goodEvaCountobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└badEvaCountobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└inviteRatioobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└userResolvedRatioobject环比指标值{"value":0.89,"preValue":0.86}
└valuenumber当前值,具体类型由指标决定,可能是整数或小数0.956
└preValuenumber同期环比值,具体类型由指标决定,可能是整数或小数0.931
└sessionInCountint64接入会话量200
└callbackCountint64坐席发起会话量15
└effectSessionCountint64有效会话量180
└inviteAfterEvaCountint64访客评价后客服邀评会话量6
└evaAgainAfterInviteCountint64访客评价后客服邀评且用户修改评价会话量2
└inviteEvaRatiodouble被邀参评率;当指标无法计算时可能返回 -20.6

错误码

状态码描述
14001AppKey 缺失或不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体不是合法 JSON 对象,或无法解析为满意度报表查询参数
14009频控限制:同一 appKey 对当前接口 60 秒内请求超过 1 次
14500服务内部异常;time、shuntGroup、kefuShunt、platforms 等参数格式不符合要求或服务处理失败
14501数据范围错误:endTime 大于当前时间;startTime 大于 endTime;或时间跨度超过限制
14515当前企业未开通满意度报表权限
postEndpoint
/openapi/corp/statistic/satisfaction/report
POST
/openapi/corp/statistic/satisfaction/report
curl -X POST "https://qiyukf.com/openapi/corp/statistic/satisfaction/report?time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef&checksumAlgorithm=0&appKey=9f1d7c2b8a6e4d3c" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": 200,
  "message": {
    "satisfactionRatio": {
      "value": 0.89,
      "preValue": 0.86
    },
    "evaCount": 128,
    "noEvaluationCount": 32,
    "inviteEvaCount": 96,
    "entryEvaluationCount": 20,
    "verySatisfiedCount": 80,
    "satisfiedCount": 30,
    "normalSatisfiedCount": 10,
    "veryNotSatisfiedCount": 3,
    "notSatisfiedCount": 5,
    "inviteCount": 160,
    "staffInviteCount": 70,
    "autoInviteCount": 90,
    "userResolvedCount": 100,
    "userUnResolvedCount": 12,
    "evaRatio": {
      "value": 0.89,
      "preValue": 0.86
    },
    "goodEvaCount": {
      "value": 0.89,
      "preValue": 0.86
    },
    "badEvaCount": {
      "value": 0.89,
      "preValue": 0.86
    },
    "inviteRatio": {
      "value": 0.89,
      "preValue": 0.86
    },
    "userResolvedRatio": {
      "value": 0.89,
      "preValue": 0.86
    },
    "sessionInCount": 200,
    "callbackCount": 15,
    "effectSessionCount": 180,
    "inviteAfterEvaCount": 6,
    "evaAgainAfterInviteCount": 2,
    "inviteEvaRatio": 0.6
  }
}
{
  "code": 14001,
  "message": "AppKey 缺失或不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体不是合法 JSON 对象,或无法解析为满意度报表查询参数"
}
{
  "code": 14009,
  "message": "频控限制:同一 appKey 对当前接口 60 秒内请求超过 1 次"
}
{
  "code": 14500,
  "message": "服务内部异常;time、shuntGroup、kefuShunt、platforms 等参数格式不符合要求或服务处理失败"
}
{
  "code": 14501,
  "message": "数据范围错误:endTime 大于当前时间;startTime 大于 endTime;或时间跨度超过限制"
}
{
  "code": 14515,
  "message": "当前企业未开通满意度报表权限"
}

这篇文档有帮助吗?