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

总览头部数据

查询总览头部统计数据,支持按客服、分流组、分流客服筛选。时间范围不超过 31 天(可配置),默认查询近 30 天。distributeIds/distributeStaffIds 与 staffIds 互斥。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和

请求体

名称类型必填描述示例值
startTimeint64否开始时间(毫秒时间戳),不传默认 30 天前1685548800000
endTimeint64否结束时间(毫秒时间戳),不传默认昨天 23:59:591688140799000
staffIdsint64[]否客服 ID 列表(与 distributeIds/distributeStaffIds 互斥)
sessionOriginint32否会话发起方,0-全部0
distributeIdsint64[]否分流组 ID 列表(与 staffIds 互斥)
distributeStaffIdsint64[]否分流客服 ID 列表(与 staffIds 互斥)

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messageobject在线系统总览头部统计数据
└sessionsint64总会话数10
└effectSessionsint64有效会话数10
└assignedRatiodouble接入率0.85
└effectAssignedRatiodouble有效接入率0.85
└redirectSessionsCountint64转接会话量10
└realSessionInRatiodouble实际接入率0.85
└messagesint64总消息数10
└answerRatiodouble问答比0.85
└specialAnswerRatiodouble30 秒内应答率0.85
└specialAnswer45Ratiodouble45 秒内应答率0.85
└evaFromCountint64邀评数10
└evaFromRatiodouble邀评率0.85
└satisfactionRatiodouble相对满意度0.85
└relativelySatisfiedCountint64相对满意会话数10
└relativelySatisfiedAllint64相对满意度统计总数10
└responseTotalLengthint64响应总时长60000
└responseTotalLengthAllint64响应时长统计回合数60000
└answerThirtyRatioCountint6430 秒应答会话数
└answerThirtyRatioAllint6430 秒应答率统计总数
└sessionLengthint64会话总时长60000
└sessionLengthAllint64会话时长统计总数60000
└evaluatedCountint64已评价会话数10
└evaluatedCountAllint64评价统计总数10
└firstResponseTimeCountint64首次响应总时长1720087200000
└firstResponseTimeAllint64首次响应统计总数1720087200000
└avgSucQueueTimeCountint64成功接入排队总时长1720087200000
└avgSucQueueTimeAllint64成功接入排队统计总数1720087200000
└evaRatiodouble参评率0.85
└avgTimeint64平均会话时长1720087200000
└avgRgTimeint64平均人工接待时长1720087200000
└avgFirstRespTimeint64平均首次响应时长1720087200000
└avgRespTimeint64平均响应时长1720087200000
└queueCountint64排队次数10
└avgSucQueueTimeint64平均成功排队时长1720087200000
└maxQueueTimeint64最长排队时长1720087200000
└unAssignedSessionsint64未接入会话数10
└avgFailureQueueTimeint64平均放弃排队时长1720087200000
└oneOffRatiodouble一次解决率0.85
└userResolvedRatiodouble用户问题解决率0.85
└userResolvedCountint64用户反馈已解决数量10
└userUnResolvedCountint64用户反馈未解决数量10
└queueCountMessageint64排队转留言数量10
└visitint64总来访量10
└sessionInCountint64接入会话量10
└sessionNotInCountint64未接入会话量10
└callBackCountint64客服主动发起会话量10
└notInServiceCountint64非服务时间来访量10
└slientTransCountint64系统转出量10
└humanTransCountint64人工转出量10
└overflowCountint64系统溢出量10
└evaInviteRatiodouble会话邀评率0.85
└validInviteEvalPercentdouble有效会话邀评率0.85
└einsteinTransCountint64机器人转人工会话量10
└einsteinCountint64机器人会话量10
└totalConsultCountint64总咨询来访量10
└sessionInviteCountint64会话邀请量10
└sessionInviteSuccessCountint64会话邀请成功量10
└sessionInviteRatiodouble会话邀请成功率0.85
└loginStaffCountint64登录客服账号数10
└resumeDurationdouble在线总时长0.85
└robotHostingSessionCountint64机器人托管会话量10
└robotHostingSessionRatiodouble机器人托管会话占比0.85
└avgRobotHostingDurationint64平均机器人托管时长,单位秒
└robotHostingAlertTriggeredSessionCountint64触发转人工提醒的会话量10
└einsteinTransValidCountint64机器人有效转人工会话量10
└einsteinValidCountint64机器人有效会话量10
└carrierobject扩展指标载体{"示例":1}
└userMessagesint64用户消息数10
└staffMessagesint64客服消息数10

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体 JSON 格式错误;参数互斥冲突
14500服务内部异常
14501时间范围超过限制(>31 天);结束时间不合法
postEndpoint
/openapi/statistic/overview
POST
/openapi/statistic/overview
curl -X POST "https://qiyukf.com/openapi/statistic/overview?appKey=string&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef" \  -H "Content-Type: application/json" \  -d '{}'
{
  "code": 200,
  "message": {
    "sessions": 10,
    "effectSessions": 10,
    "assignedRatio": 0.85,
    "effectAssignedRatio": 0.85,
    "redirectSessionsCount": 10,
    "realSessionInRatio": 0.85,
    "messages": 10,
    "answerRatio": 0.85,
    "specialAnswerRatio": 0.85,
    "specialAnswer45Ratio": 0.85,
    "evaFromCount": 10,
    "evaFromRatio": 0.85,
    "satisfactionRatio": 0.85,
    "relativelySatisfiedCount": 10,
    "relativelySatisfiedAll": 10,
    "responseTotalLength": 60000,
    "responseTotalLengthAll": 60000,
    "answerThirtyRatioCount": 0,
    "answerThirtyRatioAll": 0,
    "sessionLength": 60000,
    "sessionLengthAll": 60000,
    "evaluatedCount": 10,
    "evaluatedCountAll": 10,
    "firstResponseTimeCount": 1720087200000,
    "firstResponseTimeAll": 1720087200000,
    "avgSucQueueTimeCount": 1720087200000,
    "avgSucQueueTimeAll": 1720087200000,
    "evaRatio": 0.85,
    "avgTime": 1720087200000,
    "avgRgTime": 1720087200000,
    "avgFirstRespTime": 1720087200000,
    "avgRespTime": 1720087200000,
    "queueCount": 10,
    "avgSucQueueTime": 1720087200000,
    "maxQueueTime": 1720087200000,
    "unAssignedSessions": 10,
    "avgFailureQueueTime": 1720087200000,
    "oneOffRatio": 0.85,
    "userResolvedRatio": 0.85,
    "userResolvedCount": 10,
    "userUnResolvedCount": 10,
    "queueCountMessage": 10,
    "visit": 10,
    "sessionInCount": 10,
    "sessionNotInCount": 10,
    "callBackCount": 10,
    "notInServiceCount": 10,
    "slientTransCount": 10,
    "humanTransCount": 10,
    "overflowCount": 10,
    "evaInviteRatio": 0.85,
    "validInviteEvalPercent": 0.85,
    "einsteinTransCount": 10,
    "einsteinCount": 10,
    "totalConsultCount": 10,
    "sessionInviteCount": 10,
    "sessionInviteSuccessCount": 10,
    "sessionInviteRatio": 0.85,
    "loginStaffCount": 10,
    "resumeDuration": 0.85,
    "robotHostingSessionCount": 10,
    "robotHostingSessionRatio": 0.85,
    "avgRobotHostingDuration": 0,
    "robotHostingAlertTriggeredSessionCount": 10,
    "einsteinTransValidCount": 10,
    "einsteinValidCount": 10,
    "carrier": {
      "示例": 1
    },
    "userMessages": 10,
    "staffMessages": 10
  }
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体 JSON 格式错误;参数互斥冲突"
}
{
  "code": 14500,
  "message": "服务内部异常"
}
{
  "code": 14501,
  "message": "时间范围超过限制(>31 天);结束时间不合法"
}

这篇文档有帮助吗?