You need to enable JavaScript to run this app.
文档中心
应用性能监控全链路版

应用性能监控全链路版

复制全文
下载 pdf
页面列表
UrlOverviewMetrics
复制全文
下载 pdf
UrlOverviewMetrics
获取页面相关指标。​
请求说明​
客户端监控已在全球多个地域部署服务,旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 服务地址 文档,根据业务所在地选择最合适的接入点。​
  • 请求方式:POST​
  • 请求地址:https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UrlOverviewMetrics&Version=2022-10-12​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数,更多详细信息参见 公共参数 。​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
UrlOverviewMetrics​
接口名称。当前 API 的名称为 UrlOverviewMetrics。​
Version​
String​
是​
2022-10-12​
接口版本。当前 API 的版本为 2022-10-12。​
common​
Object of CommonParams​
是​
-​
通用参数。​
​
CommonParams​
​
参数​
类型​
是否必选​
示例值​
描述​
aid​
Long​
是​
12345​
应用ID。​
site_type​
String​
是​
web​
站点类型。​
env​
String​
是​
online​
环境,填""时为全部。​
os​
String​
否​
webpro​
服务类型,可选值为webpro,app,minipro。​
user​
String​
否​
test_user​
用户名。​
​
请求示例​
​
POST https://apmplus-openapi.cn-beijing.volcengineapi.com?Action=UrlOverviewMetrics&Version=2022-10-12​
{​
"common": {​
"aid": 12345,​
"site_type": "web",​
"env": "online",​
"os": "webpro",​
"user": "test_user"​
}​
}
​
返回参数​
​
参数​
类型​
示例值​
描述​
data​
Array of MetricList​
-​
页面指标。​
error_msg​
String​
-​
错误信息,成功为空。​
error_no​
Integer​
0​
错误码,成功为0。​
​
MetricList​
​
参数​
类型​
示例值​
描述​
name​
String​
js_error.count​
指标key。​
type​
String​
number​
指标值类型,是数值指标还是率值指标。​
unit​
String​
ms​
指标值单位。​
groupKey​
String​
js_error​
组别key。​
groupName​
String​
JS错误​
组名。​
isDefault​
Boolean​
true​
是否默认展示。​
description​
String​
PV​
指标名。​
​
返回示例​
​
{​
"error_msg": "",​
"data": [​
{​
"type": "number",​
"groupKey": "js_error",​
"isDefault": true,​
"groupName": "JS error",​
"unit": "ms",​
"name": "js_error.count",​
"description": "PV"​
}​
],​
"error_no": 0​
}
​
错误码​
当前接口暂无独立错误码,若接口调用返回异常,可参考 公共错误码 进行故障排查。​
最近更新时间:2026.08.28 16:25:38
这个页面对您有帮助吗?
有用
有用
无用
无用