查询模板报表

功能介绍

根据用户指定过滤条件查询指定智能信息模板的解析次数。当日数据需要次日16:00之后才能查询到。

URI

POST /v1/aim/template-reports/query

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
Content-Type	是	String	请求体参数类型，该字段必须设置为：application/json。

表2 请求Body参数
参数	是否必选	参数类型	描述
tpl_ids	是	Array of strings	智能信息模板ID列表，一次最多请求100个。数组长度：1 - 100
begin_time	是	String	模板报表查询开始时间。样例：2019-10-12T07:20:50.522Z。说明：开始时间和结束时间最多间隔90天，超出时间限制返回为空。最小长度：1 最大长度：30
end_time	是	String	模板报表查询结束时间。样例：2019-10-12T07:20:50.522Z。说明：开始时间和结束时间最多间隔90天，超出时间限制返回为空。最小长度：1 最大长度：30
offset	否	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。最小值：0 最大值：2147483647 缺省值：0
limit	否	Integer	每页显示的条目数量。最小值：1 最大值：100 缺省值：20
factory_type	否	Array of strings	厂商类型。不填时默认全厂商。列举值："huawei", "vivo", "oppo", "xiaomi", "meizu", "samsung"。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
template_reports	Array of AIMTemplateReport objects	查询模板报表结果集。
page_info	Page object	分页信息。

表4 AIMTemplateReport
参数	参数类型	描述
tpl_id	String	智能信息模板ID。
start_time	String	统计开始时间。样例为：1970-01-01T00:00:00Z。
resolving_times	Integer	实际已解析数。
end_time	String	统计结束时间。样例为：1970-01-01T00:00:00Z。
expose_uv	Long	消息曝光数。
expose_pv	Long	消息曝光次数。
click_uv	Long	消息点击数。
click_pv	Long	消息点击次数。

表5 Page
参数	参数类型	描述
offset	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。
limit	Integer	每页显示的条目数量。
total	Integer	总条数。

状态码： 400

表6 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。
error_msg	String	结果详情。
error_message	AnyType	结果详情。说明：该字段在以后可能会废弃，建议使用error_msg字段对接。

状态码： 500

表7 响应Body参数
参数	参数类型	描述
error_code	String	结果状态码。
error_msg	String	结果详情。
error_message	AnyType	结果详情。说明：该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例

查询模板报表。模板ID为"600000001"，查询时间范围从"2022-06-01 07:20:50" 到 "2022-07-01 07:20:50"。

https://koomessage.myhuaweicloud.cn/v1/aim/template-reports/query

{
  "tpl_ids" : [ "600000001" ],
  "begin_time" : "2022-06-01T07:20:50.522Z",
  "end_time" : "2022-07-01T07:20:50.522Z",
  "offset" : 0,
  "limit" : 10
}

响应示例

状态码： 200

返回信息。

{
  "template_reports" : [ {
    "tpl_id" : "600000001",
    "start_time" : "2022-06-30T00:00:00Z",
    "resolving_times" : 0,
    "end_time" : "2022-07-18T17:56:08Z",
    "expose_uv" : 3,
    "expose_pv" : 33,
    "click_uv" : 3,
    "click_pv" : 6
  } ],
  "page_info" : {
    "offset" : 0,
    "limit" : 10,
    "total" : 1
  }
}