文档首页 > > API参考> 问答机器人> 问答统计API>

访问统计

访问统计

分享
更新时间:2021/03/08 GMT+08:00

功能介绍

获取用户会话统计信息。

URI

  • URI格式

    GET /v1/{project_id}/qabots/{qabot_id}/requests/session-stats?start_time={start_time}&end_time={end_time}&interval={interval}&time_zone={time_zone}

  • 参数说明
表1 URI参数说明

名称

是否必选

说明

project_id

来自公有云的Project ID,用于资源隔离。

qabot_id

qabot_id,UUID格式,如:303a0a00-c88a-43e3-aa2f-d5b8b9832b02。

获取方法:

登录对话机器人服务控制台,在智能问答机器人列表中查看qabot_id。

start_time

查询的起始时间,long,UTC时间,默认值为0。

end_time

查询的结束时间,long,UTC时间,默认值为当前时间的毫秒数。

interval

统计周期目前支持month、week、day。

time_zone

请求所在时区,例如:中国东八区为"+08:00";美国西五区为"-05:00";默认为"UTC"。(注意+-:符号需要经过urlEncorder加码)

请求消息

GET https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/requests/session-stats?interval=day&time_zone=%2B08%3A00 
Request Header: 
Content-Type: application/json 
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应消息

响应参数如表1-12所示。

表2 响应参数

名称

参数类型

说明

startutc

long

统计开始时间。

调用失败时无此字段。

endutc

long

统计结束时间。

调用失败时无此字段。

interval

String

统计周期目前支持year、month、week、day。

调用失败时无此字段。

time_zone

String

所在时区,默认为"utc"。例如:中国东八区为"+08:00";美国西五区为"-05:00"。

调用失败时无此字段。

total

Object

会话总计统计数据,具体参见表3

调用失败时无此字段。

intervals

Array of Object

会话间隔统计数据,具体参见表4

调用失败时无此字段。

error_code

String

调用失败时的错误码,具体参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

表3 total字段数据结构

名称

参数类型

说明

session_count

long

会话总数。

user_count

long

独立用户个数。

avg_request_count

double

平均会话轮数,保留小数点后三位。

avg_session_time

double

平均会话时长,保留小数点后三位。

表4 intervals字段数据结构

名称

参数类型

说明

start

String

间隔周期开始时间。

session_count

long

间隔周期会话总数。

user_count

long

间隔周期独立用户个数。

avg_request_count

double

间隔周期平均会话轮数,保留小数点后三位。

avg_session_time

double

间隔周期平均会话时长,保留小数点后三位。

示例

访问统计。

  • 请求示例
    GET https://cbs-ext.cn-north-4.myhuaweicloud.com/v1/{project_id}/qabots/{qabot_id}/requests/session-stats?interval=day&time_zone=%2B08%3A00
    
    Request Header: Content-Type: application/json
    X-Auth-Token:MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • Python语言请求代码示例
    import requests
    url = "https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/requests/session-stats?start_time={start_time}&end_time={end_time}&interval={interval}&time_zone={time_zone}"
    token = "用户获取得到的实际token值"
    headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
    
    response = requests.get(url, headers=headers, json=body, verify=False)
    print(response.text)
  • 响应示例
    • 成功响应示例
      {
          "interval":"day",
          "total":{
          "session_count":122,
          "user_count":4,
          "avg_request_count":1.467,
          "avg_session_time":23909.836
      },
      "intervals":[
         {
            "start":"2021-02-14",
            "session_count":8,
            "user_count":1,
            "avg_request_count":3.500,
            "avg_session_time":157500.000
          },
         {
            "start":"2021-02-15",
            "session_count":1,
            "user_count":1,
            "avg_request_count":2.000,
            "avg_session_time":2000.000
          },
         {
            "start":"2021-02-19",
            "session_count":113,
            "user_count":4,
            "avg_request_count":1.319,
            "avg_session_time":14646.018
          }
       ],
          "startutc":1613059200000,
          "endutc":1613720965417,
          "time_zone":"+08:00"
      }
    • 失败响应示例
      {      
          "error_code":"CBS.0021",      
          "error_msg":"request parameter error"  
      }

状态码

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区论坛频道来与我们联系探讨

智能客服提问云社区提问