AnalyseSummary--应用性能监控全链路版-火山引擎

文档中心

导航

AnalyseSummary

最近更新时间：2024.07.15 16:31:27首次发布时间：2022.10.14 11:52:07

查看事件概览。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=AnalyseSummary&Version=2022-10-12

ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AnalyseSummary`	接口名称。当前 API 的名称为 `AnalyseSummary`。
Version	String	是	`2022-10-12`	接口版本。当前 API 的版本为 `2022-10-12`。

Body

参数	类型	是否必选	示例值	描述
os	String	是	`Android`	操作系统。 Android iOS
start_time	Integer	是	`1630473600`	开始时间。
end_time	Integer	是	`1630560000`	结束时间。
compare_start_time	Integer	是	`0`	对比时间区间的开始时间。
compare_end_time	Integer	是	`0`	对比时间区间的结束时间。
filters	Object of Condition	是	`-`	筛选条件，可以指定多个键值对来筛选数据。
order_by	String	是	`count`	排序方式。 count：事件上报量。 per_capita：事件人均上报。 user：事件用户数。
event_name	String	否	`event`	事件名称。
attribute_name	String	否	`name`	属性名称。
attribute_type	String	否	`metrics`	属性类型。 metrics：指标 dimension：维度

Condition

参数	类型	是否必选	示例值	描述
op	String	否	`in`	操作符。 gt：大于 gte：大于等于 lt：小于 lte：小于等于 eq：等于 neq：不等于 in：包含 not_in：不包含 lk：模糊匹配特定模式的数据 nlk：排除模糊匹配的数据
type	String	否	`expression`	筛选条件类型。 expression：当前condition是一个表达式。 and：当前condition是一个复合表达式，多个sub_condition的逻辑关系是and。 or：当前condition是一个复合表达式，多个sub_condition的逻辑关系是or。 map：当前condition是map类型。
value	String	否	`Android`	筛选值。
values	Array of String	否	`["Android"]`	筛选值，支持多个。
map_key	String	否	`key_1`	map类型key，当type为map时必填。
dimension	String	否	`aid`	条件的名称。
sub_conditions	Array of Condition	否	`-`	子条件。

返回参数

参数	类型	示例值	描述
data	JSON Map	`-`	指标数据。
error_msg	String	`success`	错误消息。
error_no	Integer	`500`	错误码。0为成功。

Data

参数类型示例值描述

参数	类型	示例值	描述
key	String	`count`	事件指标。 count：事件上报量。 per_capita：事件人均上报。 user：事件用户数。
value	Object of SummaryMetric	`-`	事件指标对应的监控数据。

key

String

count

事件指标。

count：事件上报量。
per_capita：事件人均上报。
user：事件用户数。

value Object of SummaryMetric - 事件指标对应的监控数据。

SummaryMetric

参数	类型	示例值	描述
rate	Double	`0.79`	比率。
compare	Double	`8.3`	对比值。
current	Double	`10.5`	当前值。

请求示例

POST https://open.volcengineapi.com?Action=AnalyseSummary&Version=2022-10-12
{
    "os":"iOS",
    "start_time":1658664000,
    "end_time":1658750543,
    "compare_start_time":1658577457,
    "compare_end_time":1658664000,
    "filters":{
        "type":"and",
        "sub_conditions":[
            {
                "dimension":"os",
                "op":"in",
                "type":"expression",
                "values":[
                    "iOS"
                ]
            }
        ]
    },
    "order_by":"count"
}

返回示例

{
    "err_detail": "",
    "data": {
        "count": {
            "current": 870,
            "compare": 0,
            "rate": 0
        },
        "per_capita": {
            "current": 145,
            "compare": 0,
            "rate": 0
        },
        "user": {
            "current": 6,
            "compare": 0,
            "rate": 0
        }
    },
    "error_msg": "",
    "error_no": 0
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

应用性能监控全链路版

请求说明

Header

请求参数

Query

Body

Condition

返回参数

Data

SummaryMetric

请求示例

返回示例

错误码