huawei-cloud-api-definitions-KooMessage 0.1.20240202

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"AIMTemplateReport":{"description":"查询模板返回体。","properties":{"click_pv":{"description":"消息点击次数。\n","format":"int64","type":"integer"},"click_uv":{"description":"消息点击数。\n","format":"int64","type":"integer"},"end_time":{"description":"统计结束时间。样例为:1970-01-01T00:00:00Z。","example":"1970-01-01T00:00:00Z","type":"string"},"expose_pv":{"description":"消息曝光次数。\n","format":"int64","type":"integer"},"expose_uv":{"description":"消息曝光数。\n","format":"int64","type":"integer"},"resolving_times":{"description":"实际已解析数。","type":"integer"},"start_time":{"description":"统计开始时间。样例为:1970-01-01T00:00:00Z。","example":"1970-01-01T00:00:00Z","type":"string"},"tpl_id":{"description":"智能信息模板ID。","example":"100001000","type":"string"}}},"AIMTemplateReports":{"description":"查询模板返回体。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"template_reports":{"description":"查询模板报表结果集。","items":{"$ref":"#/definitions/AIMTemplateReport"},"type":"array"}}},"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"ListAimTemplateReportsRequestBody":{"description":"模板报表查询过滤条件。","properties":{"begin_time":{"description":"模板报表查询开始时间。样例:2019-10-12T07:20:50.522Z。\n\n>开始时间和结束时间最多间隔90天,超出时间限制返回为空。\n","example":"2019-10-12T07:20:50.52Z","maxLength":30,"minLength":1,"type":"string"},"end_time":{"description":"模板报表查询结束时间。样例:2019-10-12T07:20:50.522Z。\n\n>开始时间和结束时间最多间隔90天,超出时间限制返回为空。\n","example":"2019-10-12T07:20:50.52Z","maxLength":30,"minLength":1,"type":"string"},"factory_type":{"description":"厂商类型。不填时默认全厂商。列举值:\"huawei\", \"vivo\", \"oppo\", \"xiaomi\", \"meizu\", \"samsung\"。\n","items":{"type":"string"},"type":"array"},"limit":{"description":"每页显示的条目数量。\n","example":10,"maximum":100,"minimum":1,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。\n","example":10,"maximum":2147483647,"minimum":0,"type":"integer"},"tpl_ids":{"description":"智能信息模板ID列表,一次最多请求100个。\n","example":["600000001"],"items":{"type":"string"},"maxItems":100,"minItems":1,"type":"array"}},"required":["begin_time","end_time","tpl_ids"]},"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"ab86c363e03f4818a425c8a25bea10e6","info_version":"v1","method":"post","name":"ListAimTemplateReports","parameters":{},"paths":{"/v1/aim/tempalte-reports/query":{"post":{"consumes":["application/json"],"deprecated":false,"description":"根据用户指定过滤条件查询指定智能信息模板的解析次数。当日数据需要次日16:00之后才能查询到。","operationId":"ListAimTemplateReports","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"解析任务生成报文。","in":"body","name":"ListAimTemplateReportsRequestBody","required":true,"schema":{"$ref":"#/definitions/ListAimTemplateReportsRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"page_info":{"limit":10,"offset":0,"total":1},"template_reports":[{"click_pv":6,"click_uv":3,"end_time":"2022-07-18T17:56:08Z","expose_pv":33,"expose_uv":3,"resolving_times":0,"start_time":"2022-06-30T00:00:00Z","tpl_id":"600000001"}]}},"schema":{"$ref":"#/definitions/AIMTemplateReports"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询模板报表","tags":["AIMTemplate"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-opseverity":"Info","x-request-examples-1":{"begin_time":"2022-06-01T07:20:50.522Z","end_time":"2022-07-01T07:20:50.522Z","limit":10,"offset":0,"tpl_ids":["600000001"]},"x-request-examples-description-1":"查询模板报表。模板ID为\"600000001\",查询时间范围从\"2022-06-01 07:20:50\" 到 \"2022-07-01 07:20:50\"。","x-request-examples-text-1":{"begin_time":"2022-06-01T07:20:50.522Z","end_time":"2022-07-01T07:20:50.522Z","limit":10,"offset":0,"tpl_ids":["600000001"]},"x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim/tempalte-reports/query","x-support-sdk":"Y"}}},"product_short":"KooMessage","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查询模板报表","tags":"智能信息模板","uri":null,"version":"2.0"}