获取请求总览趋势。

请求说明

客户端监控已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地选择最合适的接入点。

请求方式：POST

请求地址：https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReqOverviewTrend&Version=2022-10-12

请求参数

下方仅列出该接口特有的请求参数和部分公共参数，更多详细信息参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ReqOverviewTrend	接口名称。当前 API 的名称为 ReqOverviewTrend。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
common	Object of CommonParams	是	-	通用参数。
time_filter	Object of TimeFilter	是	-	时间区间。
filter_conditions	Object of FilterCondition	否	-	筛选条件。
slow_duration	Long	是	3000	慢请求阈值。

CommonParams

参数	类型	是否必选	示例值	描述
aid	Long	是	12345	应用ID。
site_type	String	是	web	站点类型。
env	String	是	online	环境，填""时为全部。
os	String	否	webpro	服务类型，可选值为webpro，app，minipro。
user	String	否	test_user	用户名。

TimeFilter

参数	类型	是否必选	示例值	描述
start_time	Integer	是	1665485413	起始时间，单位s。
end_time	Integer	是	1665744613	终止时间，单位s。
granularity	Integer	否	3600	聚合时间粒度，单位s。

FilterCondition

参数	类型	是否必选	示例值	描述
type	String	是	and	筛选条件类型，可选值为and和rule，只支持两层，第一层的type必须为and，第二层的type必须为rule。
field	String	否	pid	条件字段key，可选值集合由GetFieldKeys方法获取。
op	String	否	in	条件符号，可选值有eq，neq，lt，lte，gt，gte，in，not_in，regex，not_regex。
groupKey	String	否	context	map类型字段key，可选值集合由GetFieldKeys方法获取。
values	Array of String	否	[数据探索]	条件值，可选值集合由GetFieldValues方法获取。
children	Array of FilterCondition	否	-	如果下层还有条件，则放入该处，即type为and时必填。这一层与field，op，groupkey以及values不能同时存在。

请求示例

POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ReqOverviewTrend&Version=2022-10-12​
{​
    "common": {​
        "aid": 12345,​
        "site_type": "web",​
        "env": "online",​
        "os": "webpro",​
        "user": "test_user"​
    },​
    "time_filter": {​
        "start_time": 1665485413,​
        "end_time": 1665744613,​
        "granularity": 3600​
    },​
    "slow_duration": 3000,​
    "filter_conditions": {​
        "type": "and",​
        "op": "in",​
        "values": "[data explore]",​
        "groupKey": "context",​
        "field": "pid",​
        "children": [​
            {​
                "type": "and",​
                "field": "pid",​
                "children": [],​
                "values": "[data explore]",​
                "op": "in",​
                "groupKey": "context"​
            }​
        ]​
    }​
}

返回参数

参数	类型	示例值	描述
data	Object of OverviewTrendResponseData	-	总览趋势。
error_no	Integer	0	错误码，成功为0。
error_msg	String	-	错误信息，成功为空。

OverviewTrendResponseData

参数	类型	示例值	描述
info	Array of OverviewTrendInfoItem	-	自定义事件总览值。
chart	Object of ChartData	-	自定义事件上报趋势。
extra	Object of TrendExtra	-	自定义事件额外信息。

OverviewTrendInfoItem

参数	类型	示例值	描述
id	String	count	汇总值key。
name	String	白屏数	汇总值名。
unit	String	ms	汇总值单位。
count	String	1	汇总值。
change	String	1.0	环比。

ChartData

参数	类型	示例值	描述
fields	Array of Field	-	折线图/饼图维度，len(fields)=len(source[i])。
source	Array of String	[["1668355200","js_error","0","0"]]	趋势图具体点的集合，len(source)为折线图点的数量或者饼图中块数量。

TrendExtra

参数	类型	示例值	描述
release_info	Array of ReleaseInfo	-	版本发布情况。

Field

参数	类型	示例值	描述
id	String	date	维度key。
name	String	日期	维度名。
dataType	String	string	维度类型。
aggregate	String	-	聚合方式。

ReleaseInfo

参数	类型	示例值	描述
env	String	test	版本发布环境。
commit	String	[]	版本相关commit。
release	String	v2.2.123	版本。
create_at	Integer	1668483578	版本发布时间。

返回示例

{​
    "error_msg": "",​
    "data": {​
        "chart": {​
            "source": [​
                [​
                    "1668355200",​
                    "js_error",​
                    "0",​
                    "0"​
                ]​
            ],​
            "fields": [​
                {​
                    "aggregate": "increased",​
                    "dataType": "string",​
                    "name": "date",​
                    "id": "date"​
                }​
            ]​
        },​
        "extra": {​
            "release_info": [​
                {​
                    "commit": "",​
                    "release": "v2.2.123",​
                    "create_at": 1668483578,​
                    "env": "test"​
                }​
            ]​
        },​
        "info": [​
            {​
                "change": "1",​
                "count": "1",​
                "unit": "ms",​
                "id": "count",​
                "name": "blank screen count"​
            }​
        ]​
    },​
    "error_no": 0​
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。

应用性能监控全链路版