文档中心

应用性能监控全链路版

请输入

数据探索

ViewDetail

获取指定view下的性能和资源加载情况。

请求说明

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

请求方式：POST

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

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	ViewDetail	接口名称。当前 API 的名称为 ViewDetail。
Version	String	是	2022-10-12	接口版本。当前 API 的版本为 2022-10-12。
common	Object of CommonParams	是	-	通用参数。
time_filter	Object of TimeFilter	是	-	时间区间。
event_id	String	是	http:[web_monitor]{webpro#session#649b8a7b-5db4-4989-b9a5-994e53da82ee#12345}:1663186696013#fc102ce5612345edb2bd00163e352627	上报数据的唯一标识，从DataList.MetricMap中获取。

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。

请求示例

POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=ViewDetail&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​
    },​
    "event_id": "http:[web_monitor]{webpro#session#649b8a7b-5db4-4989-b9a5-994e53da82ee#12345}:1663186696013#fc102ce5612345edb2bd00163e352627"​
}

返回参数

参数	类型	示例值	描述
data	Object of ViewDetailResp	-	指定view下性能情况及资源加载情况。
error_msg	String	-	错误信息，成功为空。
error_no	Integer	0	错误码，成功为0。

ViewDetailResp

参数	类型	示例值	描述
navigation	Object of ChartData	-	性能耗时甘特图。
rum_metric	JSON Map	-	性能相关指标值。
resources_waterfall	Object of ChartDataWithExtra	-	资源加载情况。

ChartData

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

RumMetric

参数	类型	示例值	描述
key	String	-	性能指标key。
value	Object of RumMetric

ChartDataWithExtra

参数	类型	示例值	描述
data	Object of ChartData	-	返回数据。

Field

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

返回示例

{​
    "error_no": 0,​
    "error_msg": "",​
    "data": {​
        "navigation": {​
            "fields": [​
                {​
                    "dataType": "string",​
                    "id": "date",​
                    "aggregate": "",​
                    "name": "date"​
                }​
            ],​
            "source": [​
                [​
                    "1668355200",​
                    "js_error",​
                    "0",​
                    "0"​
                ]​
            ]​
        },​
        "resources_waterfall": {​
            "data": {​
                "source": [​
                    [​
                        "1668355200",​
                        "js_error",​
                        "0",​
                        "0"​
                    ]​
                ],​
                "fields": [​
                    {​
                        "name": "date",​
                        "id": "date",​
                        "aggregate": "",​
                        "dataType": "string"​
                    }​
                ]​
            }​
        }​
    }​
}

错误码

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

最近更新时间：2026.08.28 16:25:34

这个页面对您有帮助吗？

有用

无用