获取页面相关指标。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com/?Action=UrlOverviewMetrics&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | UrlOverviewMetrics | 接口名称。当前 API 的名称为 UrlOverviewMetrics。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
CommonParams
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aid | Long | 是 | 12345 | 应用ID。 |
| site_type | String | 是 | web | 站点类型。 |
| env | String | 是 | online | 环境，填""时为全部。 |
| os | String | 否 | webpro | 服务类型，可选值为webpro，app，minipro。 |
| user | String | 否 | 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 | 指标名。 |
请求示例
POST https://open.volcengineapi.com/?Action=UrlOverviewMetrics&Version=2022-10-12
{
"common": {
"aid": 12345,
"site_type": "web",
"env": "online",
"os": "webpro",
"user": "test_user"
}
}
返回示例
{
"error_msg": "",
"data": [
{
"type": "number",
"groupKey": "js_error",
"isDefault": true,
"groupName": "JS错误",
"unit": "ms",
"name": "js_error.count",
"description": "PV"
}
],
"error_no": 0
}
错误码
本接口无特有的错误码。更多信息请参见错误码。