ListStatisticReport - 开放搜索

描述

报告类统计查询，应用场景有：应用报表、下拉提示报表、热词底纹报表、abtest报表、数据质量报告等

方法

GET

URI

/v4/openapi/app-groups/[appGroupIdentity]/statistic-report/[moduleName]

请求参数

路径参数

字段	类型	是否必要	示例值	描述
appGroupIdentity	String	是	“app_group_name”	应用名称
moduleName	String	是	“suggest”	模块名称，为枚举值 · app · app-query · abtest · suggest · hot · hint · data-quality

查询参数

字段	类型	是否必要	示例值	描述
columns	String	否	“pv,uv”	查询的字段格式为 colums=”pv,uv,ipv”
startTime	Integer	否	1582214400	开始时间默认为当天0分0秒的时间戳
endTime	Integer	否	1582646399	结束时间默认为当前时间戳
pageNumber	Integer	否	1	页码，默认 pageNumber = 1
pageSize	Integer	否	10	每页返回数目，默认 pageSize = 10
query	String	否	“bizType:test,sceneTag:myTag”	查询条件，格式 k1:v1,k2:v2 · experimentSerialNumber 实验的全局唯一序列号 · sceneTag 场景标识 · bizType 业务标识 · modelId 算法模型ID

返回参数

字段	类型	描述
requestId	String	请求ID
result[]	Object	统计报告 data-quality 参考：数据采集 - 行为数据上报 app、abtest 参考：CORE 核心类指标 app-query 参考：QUERY_ANALYSIS query分析类指标
totalCount	Integer	数据总条数

示例

请求示例

GET /v4/openapi/app-groups/my_app/statistic-report/app?columns=pv,uv,ipv&startTime=1591459200&quey=bizType:alibaba

返回示例

正确返回获取bizType列表：

{
    "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
    "result": [
      {
          "bizType":"test"
      }
    ],
    "totalCount": 1
}

应用报表示例：

{
    "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
    "result": [
      {
          "pv":100,
          "ctr":0.99,
          "uv":0.56,
          "ipv":0.70
      }
    ],
    "totalCount": 1
}

数据质量报告示例：

{
  "requestId": "F76ACE3D-E510-EE2C-B7B1-39B3136A61EE",
  "result": [
    {
      "receivedCount": 100,
      "receivedSample": "[{\"received_time_ms\":1566922762148,\"message\":{\"client_ip\":\"10.101.193.208\",\"arg3\":\"100\",\"user_id\":\"test_user_2\",\"args\":\"object_id=0,object_type=ops_search_doc,ops_request_misc=%7B%22request%5Fid%22%3A%22156692276120025169650670%22%2C%22scm%22%3A%2220140713.100289989..%22%7D\",\"arg1\":\"search\",\"sdk_type\":\"opensearch_sdk\",\"session_id\":\"10.101.193.20812345678901\",\"event_id\":2001,\"sdk_version\":\"v3.2.0\",\"page\":\"detail\"}},{\"received_time_ms\":1566922762148,\"message\":{\"bhv_type\":\"click\",\"bhv_value\":\"\",\"biz_id\":123321,\"rn\":\"reqqwerqasdfasdf123124\",\"reach_time\":123321,\"item_id\":\"asb-123\",\"item_type\":2001,\"sdk_version\":\"v3.3.0\"}}]"
    }
  ],
  "totalCount": 1
}

错误返回参考：响应结构