获取所有页面总览值。

请求说明

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

请求方式：POST

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

请求参数

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

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

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=UrlOverview&Version=2022-10-12​
{​
    "common": {​
        "aid": 12345,​
        "site_type": "web",​
        "env": "online",​
        "user": "test_user",​
        "os": "webpro"​
    },​
    "time_filter": {​
        "start_time": 1665485413,​
        "end_time": 1665744613,​
        "granularity": 3600​
    },​
    "filter_conditions": {​
        "type": "and",​
        "field": "pid",​
        "groupKey": "context",​
        "op": "in",​
        "children": [​
            {​
                "type": "and",​
                "children": [],​
                "op": "in",​
                "field": "pid",​
                "groupKey": "context",​
                "values": "[data explore]"​
            }​
        ],​
        "values": "[data explore]"​
    }​
}

返回参数

参数	类型	示例值	描述
data	Object of UrlOverview	-	页面指标总览值。
error_msg	String	-	错误信息，成功为空。
error_no	Integer	0	错误码，成功为0。

UrlOverview

参数	类型	示例值	描述
count	Integer	20	pid总数。
overview_list	Array of SingleOverview	-	指标总览值。

SingleOverview

参数	类型	示例值	描述
link	String	/test	页面id，pid。
detail	Object of MetricDescription	-	指标详情。
ev_type	String	js_error	指标类型。
description	String	JS错误数最高	指标描述。

MetricDescription

参数	类型	示例值	描述
unit	String	ms	指标值单位。
good_metric	Boolean	true	正向指标还是负向指标。
metric_value	Integer	1000	指标值。

返回示例

{​
    "data": {​
        "count": 20,​
        "overview_list": [​
            {​
                "description": "JS error count",​
                "detail": {​
                    "good_metric": true,​
                    "metric_value": 1000,​
                    "unit": "ms",​
                    "metric_name": ""​
                },​
                "ev_type": "js_error",​
                "link": "/test"​
            }​
        ]​
    },​
    "error_no": 0,​
    "error_msg": ""​
}

错误码

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

应用性能监控全链路版